org.brains2b.swingext.form
Class FormAction

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by javax.swing.JPanel
                  extended by org.brains2b.swingext.form.FormAction
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public class FormAction
extends javax.swing.JPanel

Sub panel for default [Ok][Cancel][Undo][Apply] buttons

Can be used in any panel that implements org.brains2b.model.gui.Form

To set the buttons you want to display add the constants of the buttons you want displayed when invoking the Constructor
for example: FormAction.BTN_OK_CANCEL+FormAction.UNDO
Shows the [Ok][Undo] and [Cancel] button but not the [Apply] button
FormAction.BTN_ALL is just a conveniance for displaying all buttons.

You can call the Constructor(Form, buttons, ResourceBundle) to make the labels of the buttons application or language specific. Just pass the appropriate resource bundle to the Constructor given that they define the following keys and values

Note:If one of the keys is not defined there will be no ResourceException, but the default English text will be used.

Version:
0.32 [02-05-2003]
Author:
dennis
See Also:
org.brains2b.swingext.gui.Form, 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.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
static int BTN_ALL
          Constant for displaying all the buttons (Ok,Apply,Undo and Cancel)
static int BTN_APPLY
          Constant for displaying the Applyl buttons
static int BTN_CANCEL
           
static int BTN_OK
           
static int BTN_OK_CANCEL
          Constant for displaying the Ok and Cancel buttons
static int BTN_UNDO
          Constant for displaying the Undo buttons
 
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
FormAction(Form form)
          Constructor for FormAction.
FormAction(Form form, int buttons)
          Constructor for FormAction.
FormAction(Form form, int buttons, java.util.ResourceBundle msg)
          Constructor for FormAction.
 
Method Summary
 javax.swing.JButton getButton(int buttonId)
          returns the JButton Object on the basis of the id
 void setDefaultButton(int buttonId)
          Sets one of the defined buttons as default.
 void setEnabled(boolean enabled)
          overwritten default setEnabled to propagate setEnabled to all buttons when setEnabled is called on the panel
 void setEnabled(int buttonId, boolean enabled)
           
 void setFont(java.awt.Font font)
          overwritten setFont to apply to all buttons on the Panel as well as to the Panel itself.
 
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, 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, 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, setFocusTraversalKeys, 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

BTN_OK

public static final int BTN_OK
See Also:
Constant Field Values

BTN_CANCEL

public static final int BTN_CANCEL
See Also:
Constant Field Values

BTN_OK_CANCEL

public static final int BTN_OK_CANCEL
Constant for displaying the Ok and Cancel buttons

See Also:
Constant Field Values

BTN_APPLY

public static final int BTN_APPLY
Constant for displaying the Applyl buttons

See Also:
Constant Field Values

BTN_UNDO

public static final int BTN_UNDO
Constant for displaying the Undo buttons

See Also:
Constant Field Values

BTN_ALL

public static final int BTN_ALL
Constant for displaying all the buttons (Ok,Apply,Undo and Cancel)

See Also:
Constant Field Values
Constructor Detail

FormAction

public FormAction(Form form)
Constructor for FormAction.

Displays only the [Ok] and [Cancel] button

The default English labels are used for the buttons

Parameters:
form - Form, the interface that will define what to do if a button is pressed

FormAction

public FormAction(Form form,
                  int buttons)
Constructor for FormAction.

the default English labels are used for the buttons

Parameters:
parent - Form, the interface that will define what to do if a button is pressed
buttons - int, a combination of buttons (see the Constants for this class) to display

FormAction

public FormAction(Form form,
                  int buttons,
                  java.util.ResourceBundle msg)
Constructor for FormAction.

Parameters:
parent - Form, the interface that will define what to do if a button is pressed
buttons - int, a combination of buttons (see the Constants for this class) to display
msg - ResourceBundle, the resource bundle to define the labels for the buttons
Method Detail

setFont

public void setFont(java.awt.Font font)
overwritten setFont to apply to all buttons on the Panel as well as to the Panel itself.

Overrides:
setFont in class javax.swing.JComponent
See Also:
JComponent.setFont(Font)

setEnabled

public void setEnabled(boolean enabled)
overwritten default setEnabled to propagate setEnabled to all buttons when setEnabled is called on the panel

Overrides:
setEnabled in class javax.swing.JComponent
Parameters:
enabled - boolean
See Also:
JComponent.setEnabled(boolean)

setEnabled

public void setEnabled(int buttonId,
                       boolean enabled)

getButton

public javax.swing.JButton getButton(int buttonId)
returns the JButton Object on the basis of the id

Parameters:
buttonId - int
Returns:
JButton
Since:
0.32 [2-5-2003]

setDefaultButton

public void setDefaultButton(int buttonId)
Sets one of the defined buttons as default.

Only use this function after registering it to a container. Otherwise no action will be taken.

Parameters:
buttonId - int, One of the buttons as defined by the constants.
Since:
0.32 [2-5-2003]