org.kepler.gui

Class AbstractDialogTab

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.kepler.gui.AbstractDialogTab

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

Direct Known Subclasses:

DialogAnnotationsTab, DialogGeneralTab, DialogParametersTab, DialogPortsTab, DialogUnitsTab

public abstract class AbstractDialogTab
extends javax.swing.JPanel

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

Fields

Modifier and Type	Field and Description
protected TableauFrame	_frame
protected NamedObj	_target
protected java.lang.String	_targetType
protected static java.lang.String	ACTOR_TARGET_TYPE
protected static java.lang.String	DIRECTOR_TARGET_TYPE
protected static java.lang.String	WORKFLOW_TARGET_TYPE

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
AbstractDialogTab(NamedObj target, java.lang.String targetType, TableauFrame frame) Construct a new instance of this object - to be called from implementing class like this: public MyImplementationNameHere(NamedObj target) { super(target); }

Method Summary

Modifier and Type	Method and Description
protected abstract java.awt.Component	getBottomPanel() get the Component that will be displayed in the SOUTH section of the BorderLayout.
protected abstract java.awt.Component	getCenterPanel() get the Component that will be displayed in the CENTER section of the BorderLayout.
protected abstract java.awt.Component	getTopPanel() get the Component that will be displayed in the NORTH section of the BorderLayout.
protected abstract void	save() Save the user-editable values associated with this tab.
protected java.lang.String	setTargetType(java.lang.String targetType) get the string representing this type of target, to be used in the resourcebundle keys.
protected abstract boolean	validateInput() check the user input for errors/omissions.

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

Field Detail

_target

protected final NamedObj _target

_frame

protected final TableauFrame _frame

_targetType

protected final java.lang.String _targetType

ACTOR_TARGET_TYPE

protected static final java.lang.String ACTOR_TARGET_TYPE

See Also:

Constant Field Values

DIRECTOR_TARGET_TYPE

protected static final java.lang.String DIRECTOR_TARGET_TYPE

See Also:

Constant Field Values

WORKFLOW_TARGET_TYPE

protected static final java.lang.String WORKFLOW_TARGET_TYPE

See Also:

Constant Field Values

Constructor Detail

AbstractDialogTab

public AbstractDialogTab(NamedObj target,
                         java.lang.String targetType,
                         TableauFrame frame)

Construct a new instance of this object - to be called from implementing class like this: public MyImplementationNameHere(NamedObj target) { super(target); }

Parameters:

target - NamedObj the object to be configured (actor, director etc)

targetType - the string representing this type of target, to be used in the resourcebundle keys. - such as "actor", "director" etc.

Method Detail

getTopPanel

protected abstract java.awt.Component getTopPanel()

get the Component that will be displayed in the NORTH section of the BorderLayout. Note that if the dialog is resizable, this Component will need to stretch along the x axis, while retaining its aesthetic qualities

Returns:

Component

getCenterPanel

protected abstract java.awt.Component getCenterPanel()

get the Component that will be displayed in the CENTER section of the BorderLayout. Note that if the dialog is resizable, this Component will need to stretch along both the x and y axes, while retaining its aesthetic qualities

Returns:

Component

getBottomPanel

protected abstract java.awt.Component getBottomPanel()

get the Component that will be displayed in the SOUTH section of the BorderLayout. Note that if the dialog is resizable, this Component will need to stretch along the x axis, while retaining its aesthetic qualities

Returns:

Component

validateInput

protected abstract boolean validateInput()

check the user input for errors/omissions. Return true if everything is OK and we can proceed with a save(). Return false if there are problems that need to be corrected, and preferably request focus for the "problem" UI component

Returns:

boolean true if everything is OK and we can proceed with a save(). Return false if there are problems that need to be corrected, and preferably request focus for the "problem" UI component

save

protected abstract void save()

Save the user-editable values associated with this tab. The container should probably call validateInput() on each tab before saving

setTargetType

protected java.lang.String setTargetType(java.lang.String targetType)

get the string representing this type of target, to be used in the resourcebundle keys. For example, all the resourcebundle keys for actors are of the form: dialogs.actor.general.id and for directors, of the form: dialogs.director.general.id ...etc - thus, the value returned by this method if implemented in an actor dialog should be "actor"; for a director dialog, it should be "director", etc, so it can be used to generate the above example keys as follows: key = "dialogs." + getTargetType() + ".general.id"

Returns:

String representing this type of target - such as "actor", "director" etc