no.g9.client.support

Class G9DialogFrame

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JInternalFrame

no.g9.client.support.G9DialogFrame

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants

public abstract class G9DialogFrame
extends JInternalFrame

General class representing a dialog window. In addition to a JInternalFrame, this class has the capability to:

• Add G9WindowEvent listeners, (using the the addInternalFrame method. After this window is made visible (by calling on the setVisible method) it fires a G9WindowEvent, signaling that this window is indeed visible. This is usefull for listeners interessted in customizing the GUI, and is mostly for internal use.
• - Enable and disable components by the method setEnabledComponent

  It works as follows:

  • All subcomponents of a disabled component is disabled
  • Enabelig a disabled component only enables subcomponents that either have explicitly been made enabled through the setEnabledComponent method or was enabled at the time this component was disabled.

A G9MenuBar might be added to the dialog window. If so, the G9DesktopPane, will manage the dialog windows menu bar, and merge it with the application bar when ever the dialog window has focus, and clean up the application menu bar when needed. Please note that the the menu bar will be temporarily empty while it is merged with the applications menu bar (the components in the menu bar can only be in one container).

See Also:

Serialized Form

Nested Class Summary

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

JInternalFrame.AccessibleJInternalFrame, JInternalFrame.JDesktopIcon

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

Modifier and Type	Field and Description
protected Map	componentToName Map components to names
protected Set	disabledComponents disabledComponents should contain at any time the disabled components in the dialog.
protected EventListenerList	g9WindowEventListeners The list of event listeners
protected Set	mnemonicsComponents (missing javadoc)
protected Map	nameToComponent Map names to components

Fields inherited from class javax.swing.JInternalFrame

closable, CONTENT_PANE_PROPERTY, desktopIcon, FRAME_ICON_PROPERTY, frameIcon, GLASS_PANE_PROPERTY, iconable, IS_CLOSED_PROPERTY, IS_ICON_PROPERTY, IS_MAXIMUM_PROPERTY, IS_SELECTED_PROPERTY, isClosed, isIcon, isMaximum, isSelected, LAYERED_PANE_PROPERTY, maximizable, MENU_BAR_PROPERTY, resizable, ROOT_PANE_PROPERTY, rootPane, rootPaneCheckingEnabled, title, TITLE_PROPERTY

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 javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
G9DialogFrame() Default constructor.
G9DialogFrame(String title, boolean resizable, boolean closable, boolean maximizable, boolean iconifable) Constructs a new dialog frame.

Method Summary

Modifier and Type	Method and Description
void	addG9WindowListener(G9WindowListener l) Adds the specified listener to receive g9 window events from this g9 window.
protected void	addNotePage(Component page, G9TabPaneManager manager) Registers a tab pane and the corresponding tab pane manager.
protected void	addToMnemonicButtons(JButton button) Internal use.
protected void	cleanUpMnemonicButtons() Internal use.
protected void	disableComponent(Component component) Recursivly disables a component and all its children.
protected void	fireG9WindowEvent(int id) Fires a g9 window event.
String	fromComponentToName(JComponent component) Returns the name of the attribute displayed by the specified component.
JComponent	fromNameToComponent(String name) Returns the swing component associated with the specified attribute name.
abstract G9DialogController	getController() Returns the controller for this dialog.
G9MenuBar	getG9MenuBar() Gets the G9MenuBar of this dialog window, or null if this dialog window does not have a G9MenuBar set.
G9ToolBar	getG9ToolBar() Gets the G9ToolBar of this dialog window, or null if this dialog window does not have a G9ToolBar set.
protected Object	getNullValueForCell(String attribute) Internal use.
protected G9TabPaneManager	getTabManager(Component page) Gets the tab pane manager for the specified tab page.
boolean	isEnabledComponent(Component component) Returns true if the given component is enabled otherwise false.
abstract boolean	isModal() Deprecated. Internal frames support of modality is broken.
boolean	isRegisteredMnemonic(KeyStroke stroke) Internal use.
protected int	modifyKeyCode(int code) Deprecated. (missing javadoc)
protected void	registerMnemonic(int mnemonic) Internal use.
void	setClosed(boolean b) Overrides the setClosed method in JInternalFrame.
void	setEnabledComponent(Component component, boolean enable) Recursivly enables or disables a component and all its children except the components in disableComponents.
void	setEnabledComponent(Component component, boolean enable, boolean delay) Internal use only.
void	setG9MenuBar(G9MenuBar menuBar) Sets this dialog windows menu bar (using the inherited setJMenuBar(JMenuBar) method).
void	setG9ToolBar(G9ToolBar toolBar) Sets this dialog windows tool bar.
void	setVisible(boolean visible) Makes the component visible or invisible.
void	setVisible(boolean visible, boolean firstTimeOpened) Makes the component visible or invisible.
void	setVisibleComponent(Component component, boolean visible) Recursivly hides a component and all its children or recursivly shows a component and all its children except explicedly hidden children.
void	setVisibleComponent(Component component, boolean visible, boolean delay) Shows or hide the specified component.

Methods inherited from class javax.swing.JInternalFrame

addImpl, addInternalFrameListener, createRootPane, dispose, doDefaultCloseAction, fireInternalFrameEvent, getAccessibleContext, getContentPane, getDefaultCloseOperation, getDesktopIcon, getDesktopPane, getFocusCycleRootAncestor, getFocusOwner, getFrameIcon, getGlassPane, getInternalFrameListeners, getJMenuBar, getLastCursor, getLayer, getLayeredPane, getMenuBar, getMostRecentFocusOwner, getNormalBounds, getRootPane, getTitle, getUI, getUIClassID, getWarningString, hide, isClosable, isClosed, isFocusCycleRoot, isIcon, isIconifiable, isMaximizable, isMaximum, isResizable, isRootPaneCheckingEnabled, isSelected, moveToBack, moveToFront, pack, paintComponent, paramString, remove, removeInternalFrameListener, reshape, restoreSubcomponentFocus, setClosable, setContentPane, setCursor, setDefaultCloseOperation, setDesktopIcon, setFocusCycleRoot, setFrameIcon, setGlassPane, setIcon, setIconifiable, setJMenuBar, setLayer, setLayer, setLayeredPane, setLayout, setMaximizable, setMaximum, setMenuBar, setNormalBounds, setResizable, setRootPane, setRootPaneCheckingEnabled, setSelected, setTitle, setUI, show, toBack, toFront, 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, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, 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, 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, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, 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, 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, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

disabledComponents

protected final Set disabledComponents

disabledComponents should contain at any time the disabled components in the dialog. It is the job of the subclass initialise this set with "default" hidden dialog components.

g9WindowEventListeners

protected EventListenerList g9WindowEventListeners

The list of event listeners

nameToComponent

protected Map nameToComponent

Map names to components

componentToName

protected Map componentToName

Map components to names

mnemonicsComponents

protected Set mnemonicsComponents

(missing javadoc)

Constructor Detail

G9DialogFrame

public G9DialogFrame()

Default constructor. Creates a new resizable, closable, maximizable and iconifable dialog window with no title.

G9DialogFrame

public G9DialogFrame(String title,
                     boolean resizable,
                     boolean closable,
                     boolean maximizable,
                     boolean iconifable)

Constructs a new dialog frame.

Parameters:

title - the title of the frame (used in title bar)

resizable - if true the frame is resizable

closable - if true the frame is closable

maximizable - if true the frame is maxiizable

iconifable - if true the frame is iconifable

See Also:

JInternalFrame

Method Detail

addNotePage

protected void addNotePage(Component page,
                           G9TabPaneManager manager)

Registers a tab pane and the corresponding tab pane manager.

Parameters:

page - the managed tab pane.

manager - the tab pane manager.

getTabManager

protected G9TabPaneManager getTabManager(Component page)

Gets the tab pane manager for the specified tab page.

Parameters:

page - the tab page.

Returns:

the tab pane manager of the page.

fireG9WindowEvent

protected void fireG9WindowEvent(int id)

Fires a g9 window event.

Parameters:

id - the type of the event being fired; one of the following:

• G9WindowEvent.G9_DIALOG_VISIBLE
• G9WindowEvent.G9_DIALOG_CREATED
• G9WindowEvent.G9_DIALOG_HIDDEN

If the event type is not one of the above, nothing happens.

addG9WindowListener

public void addG9WindowListener(G9WindowListener l)

Adds the specified listener to receive g9 window events from this g9 window.

Parameters:

l - the g9 window listener

setVisible

public void setVisible(boolean visible)

Makes the component visible or invisible. Overrides JInternalFrame.setVisible. Each time a g9 dialog frame is made visible, it fires a G9WindowEvent, after the frame is painted.

Overrides:

setVisible in class JComponent

Parameters:

visible - true to make the component visible; false to make it invisible

Beaninfo:

attribute: visualUpdate true

setVisible

public void setVisible(boolean visible,
                       boolean firstTimeOpened)

Makes the component visible or invisible. If the callSetAccessPolicy parameter is true the controller's setAccessPolicy method is invoked before the opened event is fired (only applies if the window is made visible). The actual showing/hiding of the internal frame is performed by invoking super.setVisible(boolean).

Parameters:

visible - if true the frame is painted and shown.

firstTimeOpened - if true and visible is also true the setAccessPolicy-method is invoked, and the opened event is fiered

See Also:

Component.setVisible(boolean)

setEnabledComponent

public void setEnabledComponent(Component component,
                                boolean enable)

Recursivly enables or disables a component and all its children except the components in disableComponents.

Parameters:

component - the component to enable or disable

enable - if true the component is enabled.

Since:

version 8.1

setEnabledComponent

public void setEnabledComponent(Component component,
                                boolean enable,
                                boolean delay)

Internal use only.

Recursivly enables or disables a component and all its children except the components in disableComponents. The delay parameter controlls wheter the disabling should be delayed or not. If, true other tasks and events (such as focus shifts) on the EDT are allowed to finish before this task.

Parameters:

component - the component to enable or disable

enable - if true the component is enabled

delay - if true the task is put last on the EDT

isEnabledComponent

public boolean isEnabledComponent(Component component)

Returns true if the given component is enabled otherwise false.

Parameters:

component - a component

Returns:

Returns true if the given component is enabled otherwise false.

disableComponent

protected void disableComponent(Component component)

Recursivly disables a component and all its children.

Parameters:

component - the component to disable

Since:

version 8.1

setVisibleComponent

public void setVisibleComponent(Component component,
                                boolean visible,
                                boolean delay)

Shows or hide the specified component.

Parameters:

component - the component to show or hide

visible - flag indicating if component should be shown or hidden, true indicating show.

delay - flag indicating if component should be shown or hidden imidiatly or delayed (allowing other tasks on EDT to finish)

setVisibleComponent

public void setVisibleComponent(Component component,
                                boolean visible)

Recursivly hides a component and all its children or recursivly shows a component and all its children except explicedly hidden children.

Parameters:

component - the component to show or hide

visible - if true the component is shown.

Since:

version 8.1

fromNameToComponent

public JComponent fromNameToComponent(String name)

Returns the swing component associated with the specified attribute name.

Parameters:

name - the name of the attribute, e.g. DomainClass.id

Returns:

the swing component used to display the attribute.

fromComponentToName

public String fromComponentToName(JComponent component)

Returns the name of the attribute displayed by the specified component.

Parameters:

component - the component that displays an attribute

Returns:

the name of the attribute

setG9MenuBar

public void setG9MenuBar(G9MenuBar menuBar)

Sets this dialog windows menu bar (using the inherited setJMenuBar(JMenuBar) method).

If a dialog window has a G9MenuBar, the menu bar will be automatically merged with the application menu bar when needed. See class description for details.

Parameters:

menuBar - the menu bar of this dialog window.

getG9MenuBar

public G9MenuBar getG9MenuBar()

Gets the G9MenuBar of this dialog window, or null if this dialog window does not have a G9MenuBar set.

Returns:

the G9MenuBar of this dialog window.

setG9ToolBar

public void setG9ToolBar(G9ToolBar toolBar)

Sets this dialog windows tool bar.

If a dialog window has a G9ToolBar, the tool bar will be automatically merged with the application menu bar when needed. See class description for details.

Parameters:

toolBar - the menu bar of this dialog window.

getG9ToolBar

public G9ToolBar getG9ToolBar()

Gets the G9ToolBar of this dialog window, or null if this dialog window does not have a G9ToolBar set.

Returns:

the G9ToolBar of this dialog window.

getController

public abstract G9DialogController getController()

Returns the controller for this dialog.

Returns:

the dialog controller.

modifyKeyCode

@Deprecated
protected int modifyKeyCode(int code)

Deprecated. (missing javadoc)

Internal use.

Parameters:

code - (missing javadoc)

Returns:

the modified code.

isModal

@Deprecated
public abstract boolean isModal()

Deprecated. Internal frames support of modality is broken.

Returns true if this dialog is modal.

Returns:

a boolean value, true indicating that the frame is modal.

setClosed

public void setClosed(boolean b)

Overrides the setClosed method in JInternalFrame. When this method is invoked (as it is when the user presses Ctrl F4, the default close action is invoked.

Overrides:

setClosed in class JInternalFrame

Parameters:

b - not used

getNullValueForCell

protected Object getNullValueForCell(String attribute)

Internal use.

Used by listblock lines that needs to supply a renderer for a cell holding a null value. If the cell value is null the line invokes this method and will pass the resulting value to the cell-renderer.

• If the corresponding edit-field is a check box, a Boolean initialized to false is returned.
• If the corresponding edit-field is a combo box, the text representation of the combo's first item is returned.
• Otherwise null is returned.

Parameters:

attribute - the domain attribute

Returns:

a properly configured value the cell renderer can use.

registerMnemonic

protected void registerMnemonic(int mnemonic)

Internal use. Registers a mnemonic

Parameters:

mnemonic - the mnemonic

addToMnemonicButtons

protected void addToMnemonicButtons(JButton button)

Internal use. Adds the button to the list of buttons with mnemonics.

Parameters:

button - (missing javadoc)

cleanUpMnemonicButtons

protected void cleanUpMnemonicButtons()

Internal use. Removes the buttons with mnemonics. This is done in order to avoid a memory leakage when creating a dialog box.

isRegisteredMnemonic

public boolean isRegisteredMnemonic(KeyStroke stroke)

Internal use. Check if the specified stroke constitutes a registered mnemonic.

Parameters:

stroke - the stroke

Returns:

true if the stroke is a registered mnemonic