org.openbp.guiclient.model.item.itemtree
Class ItemSelectionDialog

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Dialog
                  javax.swing.JDialog
                      org.openbp.swing.components.JStandardDialog
                          org.openbp.guiclient.model.item.itemtree.ItemSelectionDialog

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants, ItemTreeListener

Direct Known Subclasses:

DataMemberSelectionDlg

public class ItemSelectionDialog
extends JStandardDialog
implements ItemTreeListener

Item selection dialog.

Author:

Heiko Erhardt

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JDialog.AccessibleJDialog

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

java.awt.Dialog.AccessibleAWTDialog, java.awt.Dialog.ModalExclusionType, java.awt.Dialog.ModalityType

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

java.awt.Window.AccessibleAWTWindow

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

protected ItemTree

tree Tree

Fields inherited from class javax.swing.JDialog

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Dialog

DEFAULT_MODALITY_TYPE

Fields inherited from class java.awt.Component

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

ItemSelectionDialog(java.awt.Frame owner, boolean modal)
Default constructor.

Method Summary

protected void	createTree() Creates the item tree.
void	expand(int level) Expands the tree up to the desired level.
java.util.List	getSelectedObjects() Gets the currently selected objects.
ItemTree	getTree() Gets the tree.
void	handleItemTreeEvent(ItemTreeEvent e) Called when an item tree event has happened.
void	rebuildTree() Rebuilds the model/item tree.
void	restoreState(ItemTreeState state) Restores the state of the item tree.
ItemTreeState	saveState() Saves the state of the item tree.
void	setRootObject(ModelObject rootObject) Sets the the root object of the item tree or null for the root of the model tree.
void	setRootVisible(boolean visible) Determines if the root node will be visible.
void	setSelectableItemTypes(java.lang.String[] selectableItemTypes) Sets the item types selectable by the user (null if no item types selectable).
void	setSelectableObjectClasses(java.lang.Class[] selectableObjectClasses) Sets the model object classes selectable by the user (null if no model objects selectable).
void	setSelectedObjects(java.util.List objects) Selects the given objects.
void	setSelectionMode(int selectionMode) Sets the selection mode.
void	setShowGroups(boolean showGroups) Sets the group display flag.
void	setSupportedItemTypes(java.lang.String[] supportedItemTypes) Sets the item types supported by this browser (null for the standard tem types).
void	setSupportedObjectClasses(java.lang.Class[] supportedObjectClasses) Sets the model object classes supported by this item browser (null if no model objects displayed).

Methods inherited from class org.openbp.swing.components.JStandardDialog

getBtnPane, getCancelBtn, getMainPane, getOkBtn, handleCancel, handleOk, isCancelled, setCancelled, setVisible

Methods inherited from class javax.swing.JDialog

addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Dialog

addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setModal, setModalityType, setResizable, setTitle, setUndecorated, show, toBack

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOwnedWindows, getOwner, getOwnerlessWindows, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, setBackground, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

tree

protected ItemTree tree

Tree

Constructor Detail

ItemSelectionDialog

public ItemSelectionDialog(java.awt.Frame owner,
                           boolean modal)

Default constructor.

Parameters:

owner - Owning frame. The dialog will be centered over the owner.

modal - true: Display as modal dialog.
false: Display as modeless dialog.

Method Detail

rebuildTree

public void rebuildTree()

Rebuilds the model/item tree.

saveState

public ItemTreeState saveState()

Saves the state of the item tree.

Returns:

The saved state

restoreState

public void restoreState(ItemTreeState state)

Restores the state of the item tree.

Parameters:

state - State to restore

expand

public void expand(int level)

Expands the tree up to the desired level.

Parameters:

level - Maximum level to display

createTree

protected void createTree()

Creates the item tree. Called by the constructor. Creates a regular ItemTree by default.

handleItemTreeEvent

public void handleItemTreeEvent(ItemTreeEvent e)

Called when an item tree event has happened.

Specified by:

handleItemTreeEvent in interface ItemTreeListener

Parameters:

e - Item tree event holding the event information

getSelectedObjects

public java.util.List getSelectedObjects()

Gets the currently selected objects.

Returns:

A list of ModelObject s.
The objects in the list are either items of one of the types specified in the list set by the setSelectableItemTypes(java.lang.String[]) method or objects of the model object classes set by the setSelectableObjectClasses(java.lang.Class[]) method.
If no object matching this criteria is selected or the dialog has been cancelled, null will be returned.

setSelectedObjects

public void setSelectedObjects(java.util.List objects)

Selects the given objects. The current selection will be cleared. Call this method after the tree has been initialized using the rebuildTree() method.

Parameters:

objects - A list of ModelObject s or null

setRootObject

public void setRootObject(ModelObject rootObject)

Sets the the root object of the item tree or null for the root of the model tree.

setRootVisible

public void setRootVisible(boolean visible)

Determines if the root node will be visible. Default: false.

setSupportedItemTypes

public void setSupportedItemTypes(java.lang.String[] supportedItemTypes)

Sets the item types supported by this browser (null for the standard tem types). Call this method before the plugin is installed (best use the constructor of derived classes).

setSelectableItemTypes

public void setSelectableItemTypes(java.lang.String[] selectableItemTypes)

Sets the item types selectable by the user (null if no item types selectable).

setSupportedObjectClasses

public void setSupportedObjectClasses(java.lang.Class[] supportedObjectClasses)

Sets the model object classes supported by this item browser (null if no model objects displayed).

setSelectableObjectClasses

public void setSelectableObjectClasses(java.lang.Class[] selectableObjectClasses)

Sets the model object classes selectable by the user (null if no model objects selectable).

setShowGroups

public void setShowGroups(boolean showGroups)

Sets the group display flag.

setSelectionMode

public void setSelectionMode(int selectionMode)

Sets the selection mode.

Parameters:

selectionMode - ItemTree.SELECTION_NONE/ItemTree.SELECTION_SINGLE/ItemTree.SELECTION_MULTI

getTree

public ItemTree getTree()

Gets the tree.