Class FWBoxPanel
java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JPanel
net.simplace.pipe.util.components.FWBoxPanel
- All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, Accessible
Use this class to easily build groups of widgets like buttons, checkboxes or popup buttons in a row or column
(box layout), with struts and glue in between. Added buttons are remembered by action or action command.
- Author:
- Andreas Enders
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class JPanel
JPanel.AccessibleJPanelNested classes/interfaces inherited from class JComponent
JComponent.AccessibleJComponentNested classes/interfaces inherited from class Container
Container.AccessibleAWTContainerNested classes/interfaces inherited from class Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intParameter for X-Axis rangestatic final intParameter for Y-Axis rangeFields inherited from class JComponent
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOWFields inherited from class Component
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENTFields inherited from interface ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH -
Constructor Summary
ConstructorsConstructorDescriptionConstructor for FWBoxPanel - X-Axis is used by default.FWBoxPanel(int aAxis) Constructor for FWBoxPanel with the given axis. -
Method Summary
Modifier and TypeMethodDescriptionaddButton(String aCaption, char aMnemonic, ActionListener aActionListener, String aActionCommand, boolean aEnabled) Adds a button.addButton(String aCaption, char aMnemonic, ActionListener aActionListener, String aActionCommand, boolean aEnabled, Icon aIcon) Adds a button with icon.addButton(String aCaption, ActionListener aActionListener, String aActionCommand) Adds an enabled button; the first letter of the caption is the mnemonic.addButton(String aCaption, ActionListener aActionListener, String aActionCommand, boolean aEnabled) Adds a button; the first letter of the caption is the mnemonic.Adds a button for an action.voidAdds a button (remembered by its action command, if any).addCheckbox(String aCaption, ItemListener aItemListener, boolean aSelected) Adds a checkbox with item listener (not remembered).addCheckbox(String aCaption, String aActionCommand, ActionListener aActionListener, boolean aSelected) Adds a checkbox with action listener (remembered by action command).addDefaultButton(String aButtonType, String aActionCommand, ActionListener aActionListener) Adds an enabled default button (localised caption and icon of the type).addDefaultButton(String aButtonType, String aActionCommand, ActionListener aActionListener, boolean aEnabled) Adds a default button (localised caption and icon of the type).addDynamicStrut(int aMinWidth, int aPrefWidth) Adds a space along the axis that may shrink to a minimum size.voidaddGlue()adds a GluevoidaddStrut()Adding Strut of 6 pxaddStrut(int aWidth) Adds a fixed space along the axis.voidsetEnabled(String aActionCommand, boolean aEnabled) Enables or disables the button with an action command.voidsetEnabled(Action aAction, boolean aEnabled) Enables or disables the button of an action.Methods inherited from class JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUIMethods inherited from class 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, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, 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, updateMethods inherited from class 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, transferFocusDownCycle, validate, validateTreeMethods inherited from class 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, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, 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, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
-
Field Details
-
X_AXIS
public static final int X_AXISParameter for X-Axis range- See Also:
-
Y_AXIS
public static final int Y_AXISParameter for Y-Axis range- See Also:
-
-
Constructor Details
-
FWBoxPanel
public FWBoxPanel()Constructor for FWBoxPanel - X-Axis is used by default. -
FWBoxPanel
-
-
Method Details
-
addButton
-
addButton
Adds a button (remembered by its action command, if any).- Parameters:
aButton- the button
-
addButton
Adds an enabled button; the first letter of the caption is the mnemonic.- Parameters:
aCaption- caption of the buttonaActionListener- listener of the buttonaActionCommand- action command- Returns:
- the button
-
addButton
public FWButton addButton(String aCaption, ActionListener aActionListener, String aActionCommand, boolean aEnabled) Adds a button; the first letter of the caption is the mnemonic.- Parameters:
aCaption- caption of the buttonaActionListener- listener of the buttonaActionCommand- action commandaEnabled-trueif the button is enabled- Returns:
- the button
-
addButton
public FWButton addButton(String aCaption, char aMnemonic, ActionListener aActionListener, String aActionCommand, boolean aEnabled) Adds a button.- Parameters:
aCaption- caption of the buttonaMnemonic- mnemonicaActionListener- listener of the buttonaActionCommand- action commandaEnabled-trueif the button is enabled- Returns:
- the button
-
addButton
public FWButton addButton(String aCaption, char aMnemonic, ActionListener aActionListener, String aActionCommand, boolean aEnabled, Icon aIcon) Adds a button with icon.- Parameters:
aCaption- caption of the buttonaMnemonic- mnemonicaActionListener- listener of the buttonaActionCommand- action commandaEnabled-trueif the button is enabledaIcon- icon, ornull- Returns:
- the button
-
addDefaultButton
public FWButton addDefaultButton(String aButtonType, String aActionCommand, ActionListener aActionListener) Adds an enabled default button (localised caption and icon of the type).- Parameters:
aButtonType- button type, one of theFWButton.BUTTON_*constantsaActionCommand- action commandaActionListener- listener of the button- Returns:
- the added Button for keeping the reference
-
addDefaultButton
public FWButton addDefaultButton(String aButtonType, String aActionCommand, ActionListener aActionListener, boolean aEnabled) Adds a default button (localised caption and icon of the type).- Parameters:
aButtonType- button type, one of theFWButton.BUTTON_*constantsaActionCommand- action commandaActionListener- listener of the buttonaEnabled-trueif the button is enabled- Returns:
- the added Button for keeping the reference
-
addCheckbox
public JCheckBox addCheckbox(String aCaption, String aActionCommand, ActionListener aActionListener, boolean aSelected) Adds a checkbox with action listener (remembered by action command).- Parameters:
aCaption- caption of the checkboxaActionCommand- action commandaActionListener- listener of the checkboxaSelected- initial state- Returns:
- the new JCheckBox
-
addCheckbox
Adds a checkbox with item listener (not remembered).- Parameters:
aCaption- caption of the checkboxaItemListener- listener of the checkboxaSelected- initial state- Returns:
- the new JCheckBox
-
addStrut
public void addStrut()Adding Strut of 6 px -
addStrut
Adds a fixed space along the axis.- Parameters:
aWidth- size of the space in pixels- Returns:
- the strut component
-
addDynamicStrut
Adds a space along the axis that may shrink to a minimum size.- Parameters:
aMinWidth- minimum size in pixelsaPrefWidth- preferred (and maximum) size in pixels- Returns:
- the strut component
-
addGlue
public void addGlue()adds a Glue -
getButton
- Parameters:
aAction- the action- Returns:
- the button added for the action, or
null
-
getButton
- Parameters:
aActionCommand- the action command- Returns:
- the button with the action command, or
null
-
setEnabled
Enables or disables the button of an action.- Parameters:
aAction- the actionaEnabled-trueto enable
-
setEnabled
Enables or disables the button with an action command.- Parameters:
aActionCommand- the action commandaEnabled-trueto enable
-