wt.clients.csm.ranking
Class InlineRankingValueEditorWidget

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  wt.clients.csm.ranking.InlineRankingValueEditorWidget

All Implemented Interfaces:

Accessible, ActionListener, EventListener, ImageObserver, InlineValueEditorWidgetInterface, InlineWidgetConstraintInterface, InlineWidgetNotifiable, MenuContainer, Serializable

public class InlineRankingValueEditorWidget

extends JPanel

implements InlineValueEditorWidgetInterface, InlineWidgetNotifiable, ActionListener, InlineWidgetConstraintInterface, Serializable

This inline value editor widget is specific only for ranking object. The definition type should be IntegerDefView. It consists of one textfield and a button to launch the ranking selector.

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

private JButton	btnSet
private static String	CLASSNAME
private IntegerDefView	definition
private boolean	dirty
private boolean	enabled
private ValueEditorListenerInterface	parentReference
private Rank	rank
protected ResourceBundle	rankingResource
private static String	RESOURCE
private String	tooltip
private JTextField	txtValue
private IntegerValueDefaultView	value
private static String	versionID
protected static String	WIDGETS_RESOURCE

Fields inherited from class javax.swing.JPanel

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.Container

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

InlineRankingValueEditorWidget()
Create the widget will no parameters.

InlineRankingValueEditorWidget(IntegerDefView definition)
Create the widget with the parameter DefinitionDefDefaultView.

InlineRankingValueEditorWidget(IntegerDefView definition, Rank rank)

Method Summary

void	actionPerformed(ActionEvent e) Inherited from ActionListener
void	addKeyListener(KeyListener listener) Add the key listener to the JComponent inside the widget.
InlineValueEditorWidgetInterface	createNewWidget() Create a new widget will the same type as itself.
protected void	displayExceptionMessage(String key, Object[] params)
AttributeDefDefaultView	getAttributeDefinition() Return the Attribute Definition.
ValueContentConstraint	getConstraint()
AbstractValueView[]	getNewValues() Get the new values.
ValueEditorListenerInterface	getParentReference()
AbstractValueView	getShownValue() Get the currently shown value from the widget.
String	getToolTipText()
protected void	initResource() Initialize resource bundle for internationalization and localization.
void	inlineButtonAction()
boolean	isDirty() Return whether the widget has changed or not.
boolean	isWidgetEnabled() Return whether the widget is enabled or not.
void	removeKeyListener(KeyListener listener) Remove the KeyListener from the JComponent inside the widget.
void	removeShownValue() Remove the shown value.
void	setAttributeDefinition(AttributeDefDefaultView definition) Set the Attribute Definition.
void	setConstraint(ValueContentConstraint constraint)
void	setDirty(boolean dirty)
void	setMultiLineToolTip(String tooltip) Set the tooltip text to the JComponent inside the widget.
void	setParentReference(ValueEditorListenerInterface parent)
void	setShownValue(AbstractValueView obj) Set the AbstractValueView to be displayed in the widget.
void	setWidgetEnabled(boolean enabled) Change the widget state from enabled to disabled.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, 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, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, transferFocusBackward, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, 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, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, 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

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

versionID

private static final String versionID

See Also:

Constant Field Values

txtValue

private JTextField txtValue

btnSet

private JButton btnSet

parentReference

private ValueEditorListenerInterface parentReference

enabled

private boolean enabled

value

private IntegerValueDefaultView value

dirty

private boolean dirty

definition

private IntegerDefView definition

rank

private Rank rank

tooltip

private String tooltip

WIDGETS_RESOURCE

protected static final String WIDGETS_RESOURCE

See Also:

Constant Field Values

rankingResource

protected ResourceBundle rankingResource

Constructor Detail

InlineRankingValueEditorWidget

public InlineRankingValueEditorWidget()

Create the widget will no parameters. It will construct the UI components.

InlineRankingValueEditorWidget

public InlineRankingValueEditorWidget(IntegerDefView definition)

Create the widget with the parameter DefinitionDefDefaultView.

Parameters:

definition -

InlineRankingValueEditorWidget

public InlineRankingValueEditorWidget(IntegerDefView definition,
                                      Rank rank)

Parameters:

definition -

rank -

Method Detail

initResource

protected void initResource()

Initialize resource bundle for internationalization and localization.

actionPerformed

public void actionPerformed(ActionEvent e)

Inherited from ActionListener

Specified by:

actionPerformed in interface ActionListener

Parameters:

e -

getShownValue

public AbstractValueView getShownValue()
                                throws ActionAbortedException

Get the currently shown value from the widget. The return type will be AbstractValueView. Proper conversion will be done from String to different data types before saving into the AbstractValueView object.

Specified by:

getShownValue in interface InlineValueEditorWidgetInterface

Returns:

AbstractValueView

Throws:

ActionAbortedException

getNewValues

public AbstractValueView[] getNewValues()
                                 throws ActionAbortedException

Get the new values. If there is no AbstractValueView object associated with the widget, an AbstractValueView object will be created and the displaying value will be saved into this object. Because of the multiple values created in the Reference widget, it will return an array containing all the new objects.

Specified by:

getNewValues in interface InlineValueEditorWidgetInterface

Returns:

AbstractValueView[]

Throws:

ActionAbortedException

setShownValue

public void setShownValue(AbstractValueView obj)
                   throws ActionAbortedException

Set the AbstractValueView to be displayed in the widget.

Specified by:

setShownValue in interface InlineValueEditorWidgetInterface

Parameters:

obj -

Throws:

ActionAbortedException

removeShownValue

public void removeShownValue()

Remove the shown value. It will remove the cache inside the widget and also remove the textfield entries if any.

Specified by:

removeShownValue in interface InlineValueEditorWidgetInterface

setWidgetEnabled

public void setWidgetEnabled(boolean enabled)

Change the widget state from enabled to disabled. For buttons, it will be disabled. For textfields, it will be non-editable.

Specified by:

setWidgetEnabled in interface InlineValueEditorWidgetInterface

Parameters:

enabled -

isWidgetEnabled

public boolean isWidgetEnabled()

Return whether the widget is enabled or not.

Specified by:

isWidgetEnabled in interface InlineValueEditorWidgetInterface

Returns:

boolean

createNewWidget

public InlineValueEditorWidgetInterface createNewWidget()

Create a new widget will the same type as itself. Definition will be passed to the new widget.

Specified by:

createNewWidget in interface InlineValueEditorWidgetInterface

Returns:

InlineValueEditorWidgetInterface

setMultiLineToolTip

public void setMultiLineToolTip(String tooltip)

Set the tooltip text to the JComponent inside the widget. The tooltip can be multiple lines.

Specified by:

setMultiLineToolTip in interface InlineValueEditorWidgetInterface

Parameters:

tooltip -

getToolTipText

public String getToolTipText()

Specified by:

getToolTipText in interface InlineValueEditorWidgetInterface

Returns:

String

addKeyListener

public void addKeyListener(KeyListener listener)

Add the key listener to the JComponent inside the widget.

Specified by:

addKeyListener in interface InlineValueEditorWidgetInterface

Parameters:

listener -

removeKeyListener

public void removeKeyListener(KeyListener listener)

Remove the KeyListener from the JComponent inside the widget.

Specified by:

removeKeyListener in interface InlineValueEditorWidgetInterface

Parameters:

listener -

setDirty

public void setDirty(boolean dirty)

Specified by:

setDirty in interface InlineValueEditorWidgetInterface

Parameters:

dirty -

isDirty

public boolean isDirty()

Return whether the widget has changed or not.

Specified by:

isDirty in interface InlineValueEditorWidgetInterface

Returns:

boolean

setAttributeDefinition

public void setAttributeDefinition(AttributeDefDefaultView definition)

Set the Attribute Definition.

Specified by:

setAttributeDefinition in interface InlineValueEditorWidgetInterface

Parameters:

definition -

getAttributeDefinition

public AttributeDefDefaultView getAttributeDefinition()

Return the Attribute Definition.

Specified by:

getAttributeDefinition in interface InlineValueEditorWidgetInterface

Returns:

AttributeDefDefaultView

setParentReference

public void setParentReference(ValueEditorListenerInterface parent)

Specified by:

setParentReference in interface InlineWidgetNotifiable

Parameters:

parent -

getParentReference

public ValueEditorListenerInterface getParentReference()

Specified by:

getParentReference in interface InlineWidgetNotifiable

Returns:

ValueEditorListenerInterface

inlineButtonAction

public void inlineButtonAction()

Specified by:

inlineButtonAction in interface InlineWidgetNotifiable

setConstraint

public void setConstraint(ValueContentConstraint constraint)

Specified by:

setConstraint in interface InlineWidgetConstraintInterface

Parameters:

constraint -

getConstraint

public ValueContentConstraint getConstraint()

Specified by:

getConstraint in interface InlineWidgetConstraintInterface

Returns:

ValueContentConstraint

displayExceptionMessage

protected void displayExceptionMessage(String key,
                                       Object[] params)