org.tentackle.swing

Class FormPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.tentackle.swing.FormPanel

All Implemented Interfaces:

ContainerListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, FormChangeable, FormContainer

Direct Known Subclasses:

FormCalendar, FormComponentPanel

public class FormPanel
extends JPanel
implements FormContainer, ContainerListener

Extended JPanel implementing FormContainer.

Author:

harald

See Also:

Serialized Form

Nested Class Summary

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

JPanel.AccessibleJPanel

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

JComponent.AccessibleJComponent

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

Container.AccessibleAWTContainer

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

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JComponent

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

accessibleContext, 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

Constructors

Constructor and Description
FormPanel() Creates a new FormPanel with the default FlowLayout manager and double buffering.
FormPanel(boolean doubleBuffered) Creates a new FormPanel with the default FlowLayout manager and buffering strategy.
FormPanel(LayoutManager layout) Creates a new FormPanel with the specified layout manager and double buffering.
FormPanel(LayoutManager layout, boolean doubleBuffered) Creates a new FormPanel with the specified layout manager and buffering strategy.

Method Summary

Modifier and Type	Method and Description
void	addActionListener(ActionListener listener) Adds an ActionListener. The listener can be invoked by the application on demand.
boolean	areValuesChanged() Checks whether the contents of some components in this or sub containers have changed since the last FormContainer.saveValues().
void	componentAdded(ContainerEvent e)
void	componentRemoved(ContainerEvent e)
protected FormComponentBinder	createBinder() Creates a binder for this form. The default implementation invokes FormBindingFactory.createFormComponentBinder(this).
void	fireActionPerformed(ActionEvent e) Invokes all actionListeners for this panel.
FormComponentBinder	getBinder() Gets the binder of this container.
void	getFormValues() Retrieves the values from all components in this container and all sub containers. Used to update the data from the view according to the data binding.
String	getHelpURL() Gets the online-help URL.
Window	getParentWindow() Gets the parent window.
PropertyGroup	getPropertyGroup() Gets the property group for this component.
String	getTitle() Gets the container's title.
void	invalidateParentInfo() Invalidates all container-relevant (cached) information for the hierarchy of this container's parents. For optimization purposes.
boolean	isAutoUpdate() Returns whether the auto-update feature is enabled.
boolean	isBindable() Determines whether this container is bindable.
boolean	isChangeable() Returns if this component is changeable.
boolean	isHonourChangeable() Returns whether this component should honour the changeable-attribute or not.
boolean	isTriggerValuesChangedEnabled() Determines whether triggering value changes is enabled.
void	removeActionListener(ActionListener listener) Removes an ActionListener
void	saveValues() Sets a savepoint for all components in this container and all sub containers.
void	setAutoUpdate(boolean autoupdate) Sets the auto-update feature for all components in this container and all sub containers.
void	setBindable(boolean bindable) Sets whether this container is bindable, i.e.
void	setChangeable(boolean flag) Set the component to be changeable. This is a unified abstraction and will be translated to setEditable or setEnabled, whatever is appropriate to this component.
void	setFormValues() Sets the values in all form components in this container and all sub containers. Used to update the view from the data according to the data binding.
void	setFormValuesKeepChanged() Sets the values in all unchanged form components in this container and all sub containers. All changed components are left untouched.
void	setHelpURL(String helpURL) Sets the online-help URL. If a help url is set for this container, a browser will be launched to show that url if there is no help url for the component the help was requested for.
void	setHonourChangeable(boolean flag) Sets whether this component should honour the changeable-attribute or not. The default is true.
void	setPropertyGroup(PropertyGroup group) Sets the property group for this component.
void	setTitle(String title) set the (optional) title. If the container is a window, the title is the window-title.
void	setTriggerValuesChangedEnabled(boolean enabled) Enables triggering value changes. Disabling this feature may be necessary for model-agnostic containers.
void	showHelp() Displays online help for this container.
void	triggerValuesChanged() Signals that values in the components of the container may have changed.

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, 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, 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, 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, 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, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

FormPanel

public FormPanel(LayoutManager layout,
                 boolean doubleBuffered)

Creates a new FormPanel with the specified layout manager and buffering strategy.

Parameters:

layout - the LayoutManager to use

doubleBuffered - true for double-buffering, which uses additional memory space to achieve fast, flicker-free updates (default)

FormPanel

public FormPanel(boolean doubleBuffered)

Creates a new FormPanel with the default FlowLayout manager and buffering strategy.

Parameters:

doubleBuffered - true for double-buffering, which uses additional memory space to achieve fast, flicker-free updates (default)

FormPanel

public FormPanel(LayoutManager layout)

Creates a new FormPanel with the specified layout manager and double buffering.

Parameters:

layout - the LayoutManager to use

FormPanel

public FormPanel()

Creates a new FormPanel with the default FlowLayout manager and double buffering.

Method Detail

setPropertyGroup

public void setPropertyGroup(PropertyGroup group)

Sets the property group for this component.

Parameters:

group - the property group

getPropertyGroup

public PropertyGroup getPropertyGroup()

Gets the property group for this component.

Returns:

the property group

addActionListener

public void addActionListener(ActionListener listener)

Adds an ActionListener.
The listener can be invoked by the application on demand. Currently there is no events that will trigger fireActionPerformed() automatically. This depends on the application.

Parameters:

listener - the field listener to add

removeActionListener

public void removeActionListener(ActionListener listener)

Removes an ActionListener

Parameters:

listener - the field listener to remove

fireActionPerformed

public void fireActionPerformed(ActionEvent e)

Invokes all actionListeners for this panel.

Parameters:

e - the action event

componentAdded

public void componentAdded(ContainerEvent e)

Specified by:

componentAdded in interface ContainerListener

componentRemoved

public void componentRemoved(ContainerEvent e)

Specified by:

componentRemoved in interface ContainerListener

getParentWindow

public Window getParentWindow()

Description copied from interface: FormContainer

Gets the parent window.

Specified by:

getParentWindow in interface FormContainer

Returns:

the parent window, null if none

invalidateParentInfo

public void invalidateParentInfo()

Description copied from interface: FormContainer

Invalidates all container-relevant (cached) information for the hierarchy of this container's parents.
For optimization purposes.

Specified by:

invalidateParentInfo in interface FormContainer

setAutoUpdate

public void setAutoUpdate(boolean autoupdate)

Description copied from interface: FormContainer

Sets the auto-update feature for all components in this container and all sub containers.

Specified by:

setAutoUpdate in interface FormContainer

Parameters:

autoupdate - true if auto update the data (default), false if not

See Also:

FormComponent.setAutoUpdate(boolean)

isAutoUpdate

public boolean isAutoUpdate()

Description copied from interface: FormContainer

Returns whether the auto-update feature is enabled.

Specified by:

isAutoUpdate in interface FormContainer

Returns:

true if auto update the data (default), false if not

See Also:

FormComponent.isAutoUpdate()

setFormValues

public void setFormValues()

Description copied from interface: FormContainer

Sets the values in all form components in this container and all sub containers.
Used to update the view from the data according to the data binding.

Specified by:

setFormValues in interface FormContainer

setFormValuesKeepChanged

public void setFormValuesKeepChanged()

Description copied from interface: FormContainer

Sets the values in all unchanged form components in this container and all sub containers.
All changed components are left untouched.

Specified by:

setFormValuesKeepChanged in interface FormContainer

See Also:

FormComponent.isValueChanged()

getFormValues

public void getFormValues()

Description copied from interface: FormContainer

Retrieves the values from all components in this container and all sub containers.
Used to update the data from the view according to the data binding.

Specified by:

getFormValues in interface FormContainer

saveValues

public void saveValues()

Description copied from interface: FormContainer

Sets a savepoint for all components in this container and all sub containers.

Specified by:

saveValues in interface FormContainer

See Also:

FormComponent.saveValue()

setTriggerValuesChangedEnabled

public void setTriggerValuesChangedEnabled(boolean enabled)

Description copied from interface: FormContainer

Enables triggering value changes.
Disabling this feature may be necessary for model-agnostic containers.

Specified by:

setTriggerValuesChangedEnabled in interface FormContainer

Parameters:

enabled - true if invoke FormContainer.triggerValuesChanged() on each change (default), false if not.

isTriggerValuesChangedEnabled

public boolean isTriggerValuesChangedEnabled()

Description copied from interface: FormContainer

Determines whether triggering value changes is enabled.

Specified by:

isTriggerValuesChangedEnabled in interface FormContainer

Returns:

true if invoke FormContainer.triggerValuesChanged() on each change (default), false if not.

areValuesChanged

public boolean areValuesChanged()

Description copied from interface: FormContainer

Checks whether the contents of some components in this or sub containers have changed since the last FormContainer.saveValues().

Notice that only components with (FormComponent.isTriggerValueChangedEnabled() == true) will be checked.

Specified by:

areValuesChanged in interface FormContainer

Returns:

true if changed

triggerValuesChanged

public void triggerValuesChanged()

Description copied from interface: FormContainer

Signals that values in the components of the container may have changed. The container typically uses that to invoke areValuesChanged() and enabling/disabling a button (e.g. "save", see PdoEditDialog).

Specified by:

triggerValuesChanged in interface FormContainer

setChangeable

public void setChangeable(boolean flag)

Description copied from interface: FormChangeable

Set the component to be changeable.
This is a unified abstraction and will be translated to setEditable or setEnabled, whatever is appropriate to this component.

Specified by:

setChangeable in interface FormChangeable

Parameters:

flag - true the user can edit the data, false if show only

isChangeable

public boolean isChangeable()

Description copied from interface: FormChangeable

Returns if this component is changeable.

Specified by:

isChangeable in interface FormChangeable

Returns:

true the user can edit the data, false if show only

setHonourChangeable

public void setHonourChangeable(boolean flag)

Description copied from interface: FormChangeable

Sets whether this component should honour the changeable-attribute or not.
The default is true. Notice: if this component does not honour the changeable flag, isValueChanged() always returns false and it will not perform any saveValue().

Specified by:

setHonourChangeable in interface FormChangeable

Parameters:

flag - true if honour the changeable attribute, false if not

isHonourChangeable

public boolean isHonourChangeable()

Description copied from interface: FormChangeable

Returns whether this component should honour the changeable-attribute or not.

Specified by:

isHonourChangeable in interface FormChangeable

Returns:

true if honour the changeable attribute, false if not

getTitle

public String getTitle()

Description copied from interface: FormContainer

Gets the container's title.

Specified by:

getTitle in interface FormContainer

Returns:

the container's title, null if none

setTitle

public void setTitle(String title)

Description copied from interface: FormContainer

set the (optional) title.
If the container is a window, the title is the window-title. If the container is a panel, the title is "internal", i.e. may be used by the application to trigger setting the window title, for example.

Specified by:

setTitle in interface FormContainer

Parameters:

title - the container's title, null if none

setHelpURL

public void setHelpURL(String helpURL)

Description copied from interface: FormContainer

Sets the online-help URL.
If a help url is set for this container, a browser will be launched to show that url if there is no help url for the component the help was requested for.

Specified by:

setHelpURL in interface FormContainer

Parameters:

helpURL - the help url

See Also:

FormUtilities.openHelpURL(Component)

getHelpURL

public String getHelpURL()

Description copied from interface: FormContainer

Gets the online-help URL.

Specified by:

getHelpURL in interface FormContainer

Returns:

the help url, default is null

showHelp

public void showHelp()

Description copied from interface: FormContainer

Displays online help for this container.

Specified by:

showHelp in interface FormContainer

createBinder

protected FormComponentBinder createBinder()

Creates a binder for this form.
The default implementation invokes FormBindingFactory.createFormComponentBinder(this).

Returns:

the binder

getBinder

public FormComponentBinder getBinder()

Description copied from interface: FormContainer

Gets the binder of this container.

Specified by:

getBinder in interface FormContainer

Returns:

the binder, never null.

setBindable

public void setBindable(boolean bindable)

Description copied from interface: FormContainer

Sets whether this container is bindable, i.e. should be checked within a binding hierarchy.

FormContainers are bindable by default.

Specified by:

setBindable in interface FormContainer

Parameters:

bindable - true if bindable, else not eligible for the binding process

isBindable

public boolean isBindable()

Description copied from interface: FormContainer

Determines whether this container is bindable.

Specified by:

isBindable in interface FormContainer

Returns:

true if bindable, else not eligible for the binding process