org.scopemvc.view.swing
Class SModelButton

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.AbstractButton
                          |
                          +--javax.swing.JButton
                                |
                                +--org.scopemvc.view.swing.SButton
                                      |
                                      +--org.scopemvc.view.swing.SModelButton

All Implemented Interfaces:

javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.ItemSelectable, java.awt.MenuContainer, ModelBindable, PropertyView, Refreshable, java.io.Serializable, javax.swing.SwingConstants, View

public class SModelButton

extends SButton

implements ModelBindable, PropertyView, Refreshable

An SButton that is bound to a property and performs a test on the value of the property to determine its active state.

A comparable object is used to perform the test on the view value. This button is active when the comparable object returns a value greater than 0 when passed the view value in its compareTo() method.

Note: it is convenient to use the Comparable interface to perform tests because it is already implemented in many places (natural ordering). For example, to have this SModelButton enabled when the view value is an Integer less than 1, then do:
setValueTest(new Integer(1))
because new Integer(1).compareTo(value) will return 1 if value is an Integer less than 1

If the comparison fails because of an exception coming from the Comparable test, then this button is disabled.

Version:

$Revision: 1.2 $ $Date: 2002/09/13 17:03:50 $

Author:

Ludovic Claude

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class javax.swing.JButton

javax.swing.JButton.AccessibleJButton

Nested classes inherited from class javax.swing.AbstractButton

javax.swing.AbstractButton.AccessibleAbstractButton, javax.swing.AbstractButton.ButtonChangeListener

Nested classes inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.AbstractButton

actionListener, BORDER_PAINTED_CHANGED_PROPERTY, changeEvent, changeListener, CONTENT_AREA_FILLED_CHANGED_PROPERTY, DISABLED_ICON_CHANGED_PROPERTY, DISABLED_SELECTED_ICON_CHANGED_PROPERTY, FOCUS_PAINTED_CHANGED_PROPERTY, HORIZONTAL_ALIGNMENT_CHANGED_PROPERTY, HORIZONTAL_TEXT_POSITION_CHANGED_PROPERTY, ICON_CHANGED_PROPERTY, itemListener, MARGIN_CHANGED_PROPERTY, MNEMONIC_CHANGED_PROPERTY, model, MODEL_CHANGED_PROPERTY, PRESSED_ICON_CHANGED_PROPERTY, ROLLOVER_ENABLED_CHANGED_PROPERTY, ROLLOVER_ICON_CHANGED_PROPERTY, ROLLOVER_SELECTED_ICON_CHANGED_PROPERTY, SELECTED_ICON_CHANGED_PROPERTY, TEXT_CHANGED_PROPERTY, VERTICAL_ALIGNMENT_CHANGED_PROPERTY, VERTICAL_TEXT_POSITION_CHANGED_PROPERTY

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 javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

SModelButton()
Constructor for the SModelButton object.

SModelButton(java.lang.String inControlID)
Constructor for the SModelButton object.

SModelButton(java.lang.String inControlID, Selector inSelector)
Constructor for the SModelButton object.

SModelButton(java.lang.String inControlID, Selector inSelector, java.lang.Comparable inValueTest)
Constructor for the SModelButton object.

Method Summary

protected Control	createControl() Now overwrite the firing of the control to include the additional information of the model
java.lang.Object	getBoundModel() Gets the bound model
Selector	getSelector() Gets the selector
java.lang.Comparable	getValueTest() Returns the Comparable used to test the view value.
java.lang.Object	getViewValue() Get the current value (what would be set as a property of the bound model object) being presented on the View.
void	refresh() Update the widget with the current state of the bound model.
void	setBoundModel(java.lang.Object inModel) Sets the bound model
void	setSelector(Selector inSelector) Sets the selector
void	setSelectorString(java.lang.String inSelectorString) Sets the selector string
void	setValueTest(java.lang.Comparable inValueTest) Sets the Comparable used to test the view value.
void	updateFromProperty(java.lang.Object inValue, boolean inReadOnly) Use the passed property value and read-only state to update the View.
void	validationFailed(java.lang.Exception inException) Validation failed while getting a value from View into the bound model object.
void	validationSuccess() Clear previous validation failure.

Methods inherited from class org.scopemvc.view.swing.SButton

fireActionPerformed, getControlID, getController, issueControl, setControlID, setController

Methods inherited from class javax.swing.JButton

configurePropertiesFromAction, getAccessibleContext, getUIClassID, isDefaultButton, isDefaultCapable, paramString, removeNotify, setDefaultCapable, updateUI

Methods inherited from class javax.swing.AbstractButton

addActionListener, addChangeListener, addItemListener, checkHorizontalKey, checkVerticalKey, createActionListener, createActionPropertyChangeListener, createChangeListener, createItemListener, doClick, doClick, fireItemStateChanged, fireStateChanged, getAction, getActionCommand, getActionListeners, getChangeListeners, getDisabledIcon, getDisabledSelectedIcon, getDisplayedMnemonicIndex, getHorizontalAlignment, getHorizontalTextPosition, getIcon, getIconTextGap, getItemListeners, getLabel, getMargin, getMnemonic, getModel, getMultiClickThreshhold, getPressedIcon, getRolloverIcon, getRolloverSelectedIcon, getSelectedIcon, getSelectedObjects, getText, getUI, getVerticalAlignment, getVerticalTextPosition, imageUpdate, init, isBorderPainted, isContentAreaFilled, isFocusPainted, isRolloverEnabled, isSelected, paintBorder, removeActionListener, removeChangeListener, removeItemListener, setAction, setActionCommand, setBorderPainted, setContentAreaFilled, setDisabledIcon, setDisabledSelectedIcon, setDisplayedMnemonicIndex, setEnabled, setFocusPainted, setHorizontalAlignment, setHorizontalTextPosition, setIcon, setIconTextGap, setLabel, setMargin, setMnemonic, setMnemonic, setModel, setMultiClickThreshhold, setPressedIcon, setRolloverEnabled, setRolloverIcon, setRolloverSelectedIcon, setSelected, setSelectedIcon, setText, setUI, setVerticalAlignment, setVerticalTextPosition

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, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, 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, addKeyListener, 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, 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, removeKeyListener, 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

Methods inherited from interface org.scopemvc.core.View

getController, issueControl, setController

Constructor Detail

SModelButton

public SModelButton()

Constructor for the SModelButton object.
It defines a test that will activate the button if the view value is not null.

SModelButton

public SModelButton(java.lang.String inControlID)

Constructor for the SModelButton object.
It defines a test that will activate the button if the view value is not null.

Parameters:

inControlID - The control ID to be issued by this Button

SModelButton

public SModelButton(java.lang.String inControlID,
                    Selector inSelector)

Constructor for the SModelButton object.
It defines a test that will activate the button if the view value is not null.

Parameters:

inControlID - The control ID to be issued by this Button

inSelector - The selector for the property

SModelButton

public SModelButton(java.lang.String inControlID,
                    Selector inSelector,
                    java.lang.Comparable inValueTest)

Constructor for the SModelButton object.
It defines a test that will activate the button if the view value is not null.

Parameters:

inControlID - The control ID to be issued by this Button

inSelector - The selector for the property

inValueTest - The test for the enabled state. If the compareTo() method returns a value greater than 0, then this button is active.

Method Detail

getBoundModel

public final java.lang.Object getBoundModel()

Gets the bound model

Specified by:

getBoundModel in interface View

Overrides:

getBoundModel in class SButton

Returns:

The boundModel value

getSelector

public final Selector getSelector()

Gets the selector

Specified by:

getSelector in interface PropertyView

Returns:

The selector value

getViewValue

public final java.lang.Object getViewValue()

Get the current value (what would be set as a property of the bound model object) being presented on the View.

Specified by:

getViewValue in interface ModelBindable

Returns:

property's value from the UI.

getValueTest

public java.lang.Comparable getValueTest()

Returns the Comparable used to test the view value.

Returns:

The valueTest value

setSelector

public final void setSelector(Selector inSelector)

Sets the selector

Specified by:

setSelector in interface PropertyView

Parameters:

inSelector - The new selector value

setSelectorString

public final void setSelectorString(java.lang.String inSelectorString)

Sets the selector string

Parameters:

inSelectorString - The new selectorString value

setValueTest

public void setValueTest(java.lang.Comparable inValueTest)

Sets the Comparable used to test the view value.
This action is enabled when the compareTo() method of the test returns a value greater than 0 when the passed value is the model value bound to this SModelButton.

Parameters:

inValueTest - The new valueTest value

setBoundModel

public void setBoundModel(java.lang.Object inModel)

Sets the bound model

Specified by:

setBoundModel in interface View

Overrides:

setBoundModel in class SButton

Parameters:

inModel - The new boundModel value

updateFromProperty

public void updateFromProperty(java.lang.Object inValue,
                               boolean inReadOnly)

Use the passed property value and read-only state to update the View.
Ignores inReadOnly.

Specified by:

updateFromProperty in interface ModelBindable

Parameters:

inValue - The new value of the property in the bound model

inReadOnly - The new read-only state of the property

validationFailed

public void validationFailed(java.lang.Exception inException)

Validation failed while getting a value from View into the bound model object.
Does nothing here.

Specified by:

validationFailed in interface ModelBindable

Parameters:

inException - The exception causing the validation failure

validationSuccess

public void validationSuccess()

Clear previous validation failure.
Does nothing here.

Specified by:

validationSuccess in interface ModelBindable

See Also:

ModelBindable.validationFailed(java.lang.Exception)

refresh

public void refresh()

Update the widget with the current state of the bound model.

Specified by:

refresh in interface Refreshable

createControl

protected Control createControl()

Now overwrite the firing of the control to include the additional information of the model

Overrides:

createControl in class SButton

Returns:

The Control to fire