org.cristalise.gui.tabs.outcome.form

Class OutcomeStructure

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.cristalise.gui.tabs.outcome.form.OutcomeStructure

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

Direct Known Subclasses:

DataRecord, Dimension, Field

public abstract class OutcomeStructure
extends JPanel

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

Modifier and Type	Field and Description
static ImageIcon	helpIconSmall

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
OutcomeStructure(org.exolab.castor.xml.schema.ElementDecl model, boolean readOnly, HashMap<String,Class<?>> specialControls)

Method Summary

Modifier and Type	Method and Description
abstract void	addInstance(Element myElement, Document parentDoc) After schema processing, addInstance() propogates the XML instance document down the layout.
void	addStructure(OutcomeStructure newElement) Adds a generated OutcomeStructure as a child of this one.
OutcomeStructure	createStructure(org.exolab.castor.xml.schema.ElementDecl model, boolean readOnly) Contains the rules for deciding which OutcomeStructure will represent a chosen Element Declaration.
void	enumerateElements(org.exolab.castor.xml.schema.ContentModelGroup group) Extracts child Element declarations from a content group and recursively from any group (not Element) of that group.
static String	extractHelp(org.exolab.castor.xml.schema.Annotated model)
Element	getElement()
String	getHelp()
static Class<?>	getJavaClass(int typeCode)
org.exolab.castor.xml.schema.ElementDecl	getModel()
String	getName()
boolean	getReadOnly()
static Object	getTypedValue(String value, Class<?> type)
abstract void	grabFocus()
abstract Element	initNew(Document parent)
static boolean	isEmpty(Object value)
static JLabel	makeLabel(String name, String helpText)
String	validateStructure()

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

Field Detail

helpIconSmall

public static ImageIcon helpIconSmall

Constructor Detail

OutcomeStructure

public OutcomeStructure(org.exolab.castor.xml.schema.ElementDecl model,
                        boolean readOnly,
                        HashMap<String,Class<?>> specialControls)

Method Detail

getReadOnly

public boolean getReadOnly()

createStructure

public OutcomeStructure createStructure(org.exolab.castor.xml.schema.ElementDecl model,
                                        boolean readOnly)
                                 throws OutcomeException

Contains the rules for deciding which OutcomeStructure will represent a chosen Element Declaration. In this order

1. if maxOccurs>1 then Dimension
2. SimpleTypes are Fields
3. No element children is a Field
4. Everything else is a DataRecord

Throws:

OutcomeException

enumerateElements

public void enumerateElements(org.exolab.castor.xml.schema.ContentModelGroup group)
                       throws OutcomeException

Extracts child Element declarations from a content group and recursively from any group (not Element) of that group. calls createStructure() to find the corresponding OutcomeStructure then adds it to this structure.

Throws:

OutcomeException

addStructure

public void addStructure(OutcomeStructure newElement)
                  throws OutcomeException

Adds a generated OutcomeStructure as a child of this one. A separate structure as is often overridden.

Throws:

OutcomeException

addInstance

public abstract void addInstance(Element myElement,
                                 Document parentDoc)
                          throws OutcomeException

After schema processing, addInstance() propogates the XML instance document down the layout. Most OutcomeStructures will throw an exception if called more than once, except Dimension, which is the only Outcome Structure to support maxOccurs>1

Throws:

OutcomeException

getElement

public Element getElement()

getName

public String getName()

Overrides:

getName in class Component

getModel

public org.exolab.castor.xml.schema.ElementDecl getModel()

getHelp

public String getHelp()

makeLabel

public static JLabel makeLabel(String name,
                               String helpText)

validateStructure

public String validateStructure()

initNew

public abstract Element initNew(Document parent)

extractHelp

public static String extractHelp(org.exolab.castor.xml.schema.Annotated model)

grabFocus

public abstract void grabFocus()

Overrides:

grabFocus in class JComponent

getJavaClass

public static Class<?> getJavaClass(int typeCode)

getTypedValue

public static Object getTypedValue(String value,
                                   Class<?> type)

isEmpty

public static boolean isEmpty(Object value)