com.mucommander.ui.layout
Class InformationPane

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  com.mucommander.ui.layout.InformationPane

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public class InformationPane
extends javax.swing.JPanel

InformationPane is a panel which is suitable for use in dialogs, to give information about the action that the dialog is about to perform.
It is made of 3 components:

• A 'main' label which provides a brief description of the action to be performed. By default, this label uses the standard label's font size and a bold style.
• A 'caption' label which is displayed under the main label and provides additional information about the action to be performed. This label uses a smaller font size and plain style.
• An optional icon displayed to the left of labels. InformationPane makes it easy to use one of the standard JOptionPane icons: error, information, warning, question.

Here is a textual representation of the layout, all components are vertically aligned to the top:

 --------------------------
 | [ICON] | Main label    |
 |        | Caption label |
 |________|_______________|
 
 

Author:

Maxence Bernard

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

static int	ERROR_ICON Designated the 'error' predefined icon
static int	INFORMATION_ICON Designated the 'information' predefined icon
static int	QUESTION_ICON Designated the 'question' predefined icon
static int	WARNING_ICON Designated the 'warning' predefined icon

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

InformationPane()
Creates a new InformationPane with no main and caption message.

InformationPane(java.lang.String mainMessage, java.lang.String captionMessage)
Creates a new InformationPane using the given main and caption messages and no icon.

InformationPane(java.lang.String mainMessage, java.lang.String captionMessage, int mainMessageFontStyle, javax.swing.Icon icon)
Creates a new InformationPane using the given main message, caption message, main label font style and icon.

InformationPane(java.lang.String mainMessage, java.lang.String captionMessage, int mainMessageFontStyle, int predefinedIconId)
Creates a new InformationPane using the given main message, caption message, main label font style and predefined icon.

Method Summary

javax.swing.JLabel	getCaptionLabel() Returns the caption label displayed in this InformationPane.
javax.swing.JLabel	getMainLabel() Returns the main label displayed in this InformationPane.
int	getMainLabelFontStyle() Returns the font style used by the main label as a bitwise mask.
static javax.swing.Icon	getPredefinedIcon(int predefinedIconId) Returns an Icon instance corresponding to the given predefined icon id.
void	setIcon(javax.swing.Icon icon) Changes the icon displayed in this InformationPane to the given one.
void	setMainLabelFontStyle(int fontStyle) Changes the font style used by the main label.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ERROR_ICON

public static final int ERROR_ICON

Designated the 'error' predefined icon

See Also:

Constant Field Values

INFORMATION_ICON

public static final int INFORMATION_ICON

Designated the 'information' predefined icon

See Also:

Constant Field Values

WARNING_ICON

public static final int WARNING_ICON

Designated the 'warning' predefined icon

See Also:

Constant Field Values

QUESTION_ICON

public static final int QUESTION_ICON

Designated the 'question' predefined icon

See Also:

Constant Field Values

Constructor Detail

InformationPane

public InformationPane()

Creates a new InformationPane with no main and caption message.

InformationPane

public InformationPane(java.lang.String mainMessage,
                       java.lang.String captionMessage)

Creates a new InformationPane using the given main and caption messages and no icon. The font style for the main label is set to Font.BOLD.

Parameters:

mainMessage - the message to display in the main label

captionMessage - the message to display in the caption label

InformationPane

public InformationPane(java.lang.String mainMessage,
                       java.lang.String captionMessage,
                       int mainMessageFontStyle,
                       int predefinedIconId)

Creates a new InformationPane using the given main message, caption message, main label font style and predefined icon.

Parameters:

mainMessage - the message to display in the main label

captionMessage - the message to display in the caption label

mainMessageFontStyle - the font style to use in the main label

predefinedIconId - an id designating the predefined icon to display, see constant fields for allowed values

InformationPane

public InformationPane(java.lang.String mainMessage,
                       java.lang.String captionMessage,
                       int mainMessageFontStyle,
                       javax.swing.Icon icon)

Creates a new InformationPane using the given main message, caption message, main label font style and icon.

Parameters:

mainMessage - the message to display in the main label

captionMessage - the message to display in the caption label

mainMessageFontStyle - the font style to use in the main label

icon - an icon to display, null for no icon

Method Detail

getPredefinedIcon

public static javax.swing.Icon getPredefinedIcon(int predefinedIconId)

Returns an Icon instance corresponding to the given predefined icon id.

Parameters:

predefinedIconId - an id designating a predefined icon, see constant fields for allowed values

Returns:

an Icon instance corresponding to the given predefined icon id

getMainLabel

public javax.swing.JLabel getMainLabel()

Returns the main label displayed in this InformationPane.

Returns:

the main label displayed in this InformationPane

getCaptionLabel

public javax.swing.JLabel getCaptionLabel()

Returns the caption label displayed in this InformationPane.

Returns:

the caption label displayed in this InformationPane

setIcon

public void setIcon(javax.swing.Icon icon)

Changes the icon displayed in this InformationPane to the given one. If null is specified, this InformationPane will not display any icon.

Parameters:

icon - the new icon to display, null for no icon

setMainLabelFontStyle

public void setMainLabelFontStyle(int fontStyle)

Changes the font style used by the main label. Allowed values are Font.PLAIN, Font.BOLD and Font.ITALIC or a mix of those combined as a bitwise mask.

Parameters:

fontStyle - the new font style for the main label

getMainLabelFontStyle

public int getMainLabelFontStyle()

Returns the font style used by the main label as a bitwise mask.

Returns:

the font style used by the main label as a bitwise mask