org.openbp.cockpit.itemeditor
Class StandardItemEditor

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.openbp.swing.components.wizard.WizardImpl
                      extended by org.openbp.cockpit.generator.wizard.GeneratorWizard
                          extended by org.openbp.cockpit.itemeditor.StandardItemEditor
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.event.ChangeListener, ItemEditor, Wizard
Direct Known Subclasses:
NodeItemEditor

public class StandardItemEditor
extends GeneratorWizard
implements ItemEditor

The standard item wizard displays a wizard that lets the user define an item. Do not construct this class explicitely. Instead, use the ItemEditorRegistry.lookupItemEditor(String) method to retrieve the instance of the wizard and call openItem(org.openbp.core.model.item.Item, int) on it.

Author:
Heiko Erhardt
See Also:
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.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
static java.lang.String PROPERTY_PAGE
          Item property page of the wizard
 
Fields inherited from class org.openbp.cockpit.generator.wizard.GeneratorWizard
context, RESULT_PAGE, SELECTION_PAGE, SETTINGS_PAGE
 
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
StandardItemEditor()
          Constructor.
 
Method Summary
protected  void addPropertyPage()
          Adds the property page of the standard item wizard to the wizard.
static void ensureProcessType(Item item)
          For compatibility with pre-2\.0 process items: Ensures that a process item has a process type associated with it.
 DropableDialog getDialog()
          Gets the dialog that displays the wizard.
 DragDropPane getDndPane()
          Gets the dragDropPane of the wizard dialog responsible for DnD actions.
protected  java.awt.Dimension getInitialSize()
          Gets the initial size of the dialog.
 Item openItem(Item item, int editedItemStatus)
          Opens an item in the item wizard.
protected  boolean parseGeneratorInfo(Item item)
          Parses the item's generator info.
protected  void setupPages()
          Sets up the wizard pages.
protected  void setupPosition()
          Sets up the initial page position.
 
Methods inherited from class org.openbp.cockpit.generator.wizard.GeneratorWizard
clearPages, fireWizardEvent, getContext, updateGeneratorPageSequence
 
Methods inherited from class org.openbp.swing.components.wizard.WizardImpl
addAndLinkPage, addPage, addWizardListener, canCancel, cancel, canFinish, canMoveBackward, canMoveForward, close, displayBack, displayFirst, displayNext, displayPage, finish, fireWizardEvent, getDataModel, getDefaultBackgroundImage, getDefaultWizardImage, getManager, getPage, getPageNames, getPageResourcePrefix, getPageResourceString, getPages, getResource, getResultPageName, hasBackward, hasForward, hideWizard, removePage, removeWizardListener, setDataModel, setDefaultBackgroundImage, setDefaultWizardImage, setManager, setPageResourcePrefix, setResultPage, setResultPageName, setShowHelp, setWizardResource, stateChanged, updateNavigator
 
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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, 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, 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

PROPERTY_PAGE

public static final java.lang.String PROPERTY_PAGE
Item property page of the wizard

See Also:
Constant Field Values
Constructor Detail

StandardItemEditor

public StandardItemEditor()
Constructor. Do not invoke the constructor explicitely. The constructor is provided in order to let the ItemTypeDescriptor instantiate this class. Use the ItemEditorRegistry.lookupItemEditor(String) method to retrieve the instance of the wizard and call openItem(org.openbp.core.model.item.Item, int) on it.

Method Detail

addPropertyPage

protected void addPropertyPage()
Adds the property page of the standard item wizard to the wizard.


getInitialSize

protected java.awt.Dimension getInitialSize()
Gets the initial size of the dialog.


setupPages

protected void setupPages()
Sets up the wizard pages.


setupPosition

protected void setupPosition()
Sets up the initial page position. Default: First page.


openItem

public Item openItem(Item item,
                     int editedItemStatus)
Opens an item in the item wizard. This method usually displays the wizard dialog. The item wizard displays and updates the item structure and/or advanced item properties.

Specified by:
openItem in interface ItemEditor
Parameters:
item - item to open
editedItemStatus - Status of the item
Returns:
The edited item or null if the user cancelled the wizard

parseGeneratorInfo

protected boolean parseGeneratorInfo(Item item)
Parses the item's generator info.

Parameters:
item - Item to parse
Returns:
true: The item contained valid generator info.
false: The item does not contain generator info.

ensureProcessType

public static void ensureProcessType(Item item)
For compatibility with pre-2\.0 process items: Ensures that a process item has a process type associated with it. Will assign the default process type 'UserInterface' to any process item that don't have a process type.

Parameters:
item - Item (can be a process item or any other)

getDialog

public DropableDialog getDialog()
Gets the dialog that displays the wizard.


getDndPane

public DragDropPane getDndPane()
Gets the dragDropPane of the wizard dialog responsible for DnD actions.



Copyright © 2011. All Rights Reserved.