SpinBox (SAS AppDevStudio API Developer Documentation for Java)

SpinBox is a class that combines a textField (JTextField) and a spinButton. The value in the textField can be incremented by pressing the spinButton. The SpinBox supports two types of models: an StaticOrderedCollectionInterface model or a BoundedNumberInterface model. The collection model displays one item from the collection in the textField and allows stepping throught the collection by using the spinButton. The boundedNumber model displays the value of the boundedNumber in the textField and allows it to be incremented or decremented by the spinButton. An AdjustmentEvent is fired any time the value of the SpinBox changes. An ItemEvent is also fired when the model is a collection and the value changes. The defaultModel for the SpinBox is a BoundedDouble.

Notes:

The integer methods for setting the value, max, min, blockIncrement, and unitIncrement may not be valid if the model values are not also integers.

The precision value needs to be in the form of a one digit where the value will be rounded at and zero's every where else. Example: 0.01 indicates the number will be rounded at the hundredths decimal place.

See Also:: StaticOrderedCollectionInterface, BoundedNumberInterface, JTextField, SpinButton, Serialized Form

Field Summary

protected java.awt.event.AdjustmentListener adjustmentListener


protected com.sas.swing.visuals.SpinBox.ArrowKeyAdapter arrowKeyAdapter


protected com.sas.models.BoundedNumberInterface boundedNumberModel


protected com.sas.models.BoundedNumberInterface defaultRangeModel


protected com.sas.util.transforms.TransformInterface displayTransform


protected GenericErrorHandlerInterface errorHandler


protected java.awt.event.ItemListener itemListener


static int LEFT_RIGHT
          int values representing the orientation of the spinButton arrows- LEFT_RIGHT

protected java.text.NumberFormat numberFormat


protected boolean numberFormatSet


protected double precision


protected boolean precisionDisplayed


protected PrefixPredicate prefixPredicate


static java.lang.String RB_KEY


protected SpinButton spinBtn


protected com.sas.collection.StaticOrderedCollectionInterface staticOrderedCollectionModel


protected javax.swing.JTextField text


protected boolean textInvoked


static int UP_DOWN
          int values representing the orientation of the spinButton arrows- UP_DOWN

protected ValidationInterface validator


protected boolean valueInvoked


Constructor Summary

SpinBox()
          Default constructor

Method Summary

void actionPerformed(java.awt.event.ActionEvent e)
          Handles the action performed events on the textField in the spinBox.

void addAdjustmentListener(java.awt.event.AdjustmentListener l)
          Add a listener to receive adjustment events when the value of the SpinBox changes.

void addItemListener(java.awt.event.ItemListener l)
          Add a listener to receive item events when the state of the SpinBox changes.

void adjustmentValueChanged(java.awt.event.AdjustmentEvent e)
          Handle all adjustment events that are sent out by spinButton.

void contentsChanged(com.sas.collection.ContentsChangedEvent e)
          Handle contentsChanged events from a collection model.

void focusGained(java.awt.event.FocusEvent e)
          Handles the focus gained events on the textField in the spinBox.

void focusLost(java.awt.event.FocusEvent e)
          Handles the focus lost event on the textField in the spinBox.

Alarm getAlarm()
          Deprecated.

int getArrowDirection()
          Get the direction the SpinButton arrows are pointing.

int getBlockIncrement()
          Get the block value increment for the spinButton.

java.lang.Number getBlockIncrementNumber()
          Get the blockIncrement number value for the spinButton.

int getColumns()
          Get the number of columns of the textField.

javax.swing.JButton getDecrementButton()
          Returns the button that is used to deccrement in the spinBox.

static int getDefaultHeight()


static int getDefaultWidth()


long getDelay()
          Get the delay before the spinButton begins automatically incrementing its value.

com.sas.util.transforms.TransformInterface getDisplayTransform()
          Get the displayTransform used to transform the objects in the model before they are displayed.

double getDoubleData()
          Get the double data value of the SpinBox.

GenericErrorHandlerInterface getErrorHandler()
          Returns the error handler being used for the validator on the text in the textField of the SpinBox

static com.sas.beans.ExtendedBeanInfo getExtendedBeanInfo()


javax.swing.JButton getIncrementButton()
          Returns the button that is used to increment in the spinBox.

int getMaximum()
          Get the maximum integer value of the SpinBox.

java.lang.Number getMaximumNumber()
          Get the maximum number value for the SpinBox.

int getMinimum()
          Get the minimum integer value of the SpinBox.

java.lang.Number getMinimumNumber()
          Get the minimum number value for the SpinBox.

com.sas.models.BoundedNumberInterface getModel()
          Returns the BoundedNumberInterface model that is set on the spinBox.

java.text.NumberFormat getNumberFormat()
          Get the NumberFormat applied to the value set as the text in the textField.

java.lang.Number getNumberValue()
          Get the number value of the SpinBox.

int getOrientation()
          Get the orientation of the spinButton.

double getPrecision()
          Get the precision of the value displayed in the textField.

java.util.Vector getRequiredInterfaces()
          Returns the required interfaces Vector for this component.

java.lang.Object[] getSelectedObjects()
          Get the selected object when the model is a collection.

long getStartInterval()
          Get the start interval for the spinButton alarm to increment the value.

com.sas.collection.StaticOrderedCollectionInterface getStaticOrderedCollectionModel()
          Returns the StaticOrderedCollectionInterface model that is set on the spinBox.

java.lang.String getText()
          Get the text displayed in the textField.

javax.swing.JTextField getTextField()
          Returns the textField that is used in the spinBox.

int getUnitIncrement()
          Get the integer unitIncrement of the spinButton.

java.lang.Number getUnitIncrementNumber()
          Get the unitIncrement number value for the spinButton.

ValidationInterface getValidator()
          Returns the validator being used on the text in the textField of the SpinBox

int getValue()
          Get the integer value of the SpinBox.

int getVisibleAmount()
          Not used.

protected void handleError()
          Internal routine for displaying an error message when text fails the validation rules

boolean isCycleOn()
          Get if the spinButton is set to cycle through its values.

boolean isDefaultModelAttached()
          Returns true if the default model is being used, false otherwise.

boolean isPrecisionDisplayed()
          Get if the text in the textField is displayed correctly.

void paintComponent(java.awt.Graphics g)
          Paint the SpinBox.

void propertyChange(java.beans.PropertyChangeEvent event)
          Handle property change events on complex properties.

void refresh(com.sas.ModelInterface model)
          Refresh the SpinBox with the specified model.

void removeAdjustmentListener(java.awt.event.AdjustmentListener l)
          Remove the adjustment listener.

void removeItemListener(java.awt.event.ItemListener l)
          Remove the item listener.

void setAlarm(Alarm alarm)
          Deprecated.

void setArrowDirection(int d)
          Sets the direction the SpinButton arrows are pointing.

void setBackground(java.awt.Color color)
          Sets the background color of the text field in the SpinBox

void setBlockIncrement(int block)
          Set the blockIncrement on the spinButton.

void setBlockIncrementNumber(java.lang.Number block)
          Set the blockIncrement number value for the spinButton.

void setColumns(int cols)
          Set the number of text columns on the textField.

void setCycleOn(boolean cycle)
          Set the spinButton to cycle through its values.

static void setDefaultHeight(int newHeight)


void setDefaultValues()
          Set the default internal values for the BaseButton.

static void setDefaultWidth(int newWidth)


void setDelay(long delay)
          Set the delay before the spinButton begins automatically incrementing its value.

void setDisplayTransform(com.sas.util.transforms.TransformInterface transform)
          Set the displayTransform used to transform the items in the model when the model of the SpinBox is a StaticOrderedCollectionInterface object.

void setDoubleData(double d)
          Set the double value of the SpinBox.

void setEnabled(boolean e)
          Set the SpinBox enabled.

void setErrorHandler(GenericErrorHandlerInterface newErrorHandler)
          Set the errorHandler for the validator of the text in the textField of the SpinBox.

void setForeground(java.awt.Color color)
          Sets the foreground color of the text in the SpinBox

void setMaximum(int max)
          Set the integer maximum value for the SpinBox.

void setMaximumNumber(java.lang.Number max)
          Set the maximum number value for the SpinBox.

void setMinimum(int min)
          Set the integer minimum value for the SpinBox.

void setMinimumNumber(java.lang.Number min)
          Set the minimum number value for the SpinBox.

void setModel(com.sas.models.BoundedNumberInterface model)
          Sets the BoundedNumberInterface model on the spinBox.

void setNumberFormat(java.text.NumberFormat nf)
          Set the NumberFormat applied to the value set as the text in the textField.

void setNumberValue(java.lang.Number value)
          Set the number value for the SpinBox.

void setOrientation(int orient)
          Set the orientation of the spinButton.

void setStartInterval(long startInterval)
          Set the start interval for the spinButton alarm to increment the value.

void setStaticOrderedCollectionModel(com.sas.collection.StaticOrderedCollectionInterface model)
          Sets the StaticOrderedCollectionInterface model on the spinBox.

void setText(java.lang.String txt)
          Set the text of the SpinBox.

void setToolTipText(java.lang.String txt)
          Registers the text to display in a tool tip.

void setUnitIncrement(int unit)
          Set the integer value of the unitIncrement.

void setUnitIncrementNumber(java.lang.Number unit)
          Set the unitIncrement number value for the SpinBox.

void setValidator(ValidationInterface newValidator)
          Set the validator for the text in the textField of the SpinBox.

void setValue(int val)
          Set the integer value of the SpinBox.

void setVisibleAmount(int amt)
          Not used.

protected void updateText(java.lang.Number newValue)
          Invoked when the text needs to be updated from a change in the value.

protected void updateValue(java.lang.String txt)
          Invoked when the value needs to be updated from a change in the text.

Field Summary
`protected java.awt.event.AdjustmentListener`	`adjustmentListener`
`protected com.sas.swing.visuals.SpinBox.ArrowKeyAdapter`	`arrowKeyAdapter`
`protected com.sas.models.BoundedNumberInterface`	`boundedNumberModel`
`protected com.sas.models.BoundedNumberInterface`	`defaultRangeModel`
`protected com.sas.util.transforms.TransformInterface`	`displayTransform`
`protected GenericErrorHandlerInterface`	`errorHandler`
`protected java.awt.event.ItemListener`	`itemListener`
`static int`	`LEFT_RIGHT` int values representing the orientation of the spinButton arrows- LEFT_RIGHT
`protected java.text.NumberFormat`	`numberFormat`
`protected boolean`	`numberFormatSet`
`protected double`	`precision`
`protected boolean`	`precisionDisplayed`
`protected PrefixPredicate`	`prefixPredicate`
`static java.lang.String`	`RB_KEY`
`protected SpinButton`	`spinBtn`
`protected com.sas.collection.StaticOrderedCollectionInterface`	`staticOrderedCollectionModel`
`protected javax.swing.JTextField`	`text`
`protected boolean`	`textInvoked`
`static int`	`UP_DOWN` int values representing the orientation of the spinButton arrows- UP_DOWN
`protected ValidationInterface`	`validator`
`protected boolean`	`valueInvoked`

Constructor Summary
`SpinBox()` Default constructor

Method Summary
`void`	`actionPerformed(java.awt.event.ActionEvent e)` Handles the action performed events on the textField in the spinBox.
`void`	`addAdjustmentListener(java.awt.event.AdjustmentListener l)` Add a listener to receive adjustment events when the value of the SpinBox changes.
`void`	`addItemListener(java.awt.event.ItemListener l)` Add a listener to receive item events when the state of the SpinBox changes.
`void`	`adjustmentValueChanged(java.awt.event.AdjustmentEvent e)` Handle all adjustment events that are sent out by spinButton.
`void`	`contentsChanged(com.sas.collection.ContentsChangedEvent e)` Handle contentsChanged events from a collection model.
`void`	`focusGained(java.awt.event.FocusEvent e)` Handles the focus gained events on the textField in the spinBox.
`void`	`focusLost(java.awt.event.FocusEvent e)` Handles the focus lost event on the textField in the spinBox.
`Alarm`	`getAlarm()` Deprecated.
`int`	`getArrowDirection()` Get the direction the SpinButton arrows are pointing.
`int`	`getBlockIncrement()` Get the block value increment for the spinButton.
`java.lang.Number`	`getBlockIncrementNumber()` Get the blockIncrement number value for the spinButton.
`int`	`getColumns()` Get the number of columns of the textField.
`javax.swing.JButton`	`getDecrementButton()` Returns the button that is used to deccrement in the spinBox.
`static int`	`getDefaultHeight()`
`static int`	`getDefaultWidth()`
`long`	`getDelay()` Get the delay before the spinButton begins automatically incrementing its value.
`com.sas.util.transforms.TransformInterface`	`getDisplayTransform()` Get the displayTransform used to transform the objects in the model before they are displayed.
`double`	`getDoubleData()` Get the double data value of the SpinBox.
`GenericErrorHandlerInterface`	`getErrorHandler()` Returns the error handler being used for the validator on the text in the textField of the SpinBox
`static com.sas.beans.ExtendedBeanInfo`	`getExtendedBeanInfo()`
`javax.swing.JButton`	`getIncrementButton()` Returns the button that is used to increment in the spinBox.
`int`	`getMaximum()` Get the maximum integer value of the SpinBox.
`java.lang.Number`	`getMaximumNumber()` Get the maximum number value for the SpinBox.
`int`	`getMinimum()` Get the minimum integer value of the SpinBox.
`java.lang.Number`	`getMinimumNumber()` Get the minimum number value for the SpinBox.
`com.sas.models.BoundedNumberInterface`	`getModel()` Returns the BoundedNumberInterface model that is set on the spinBox.
`java.text.NumberFormat`	`getNumberFormat()` Get the NumberFormat applied to the value set as the text in the textField.
`java.lang.Number`	`getNumberValue()` Get the number value of the SpinBox.
`int`	`getOrientation()` Get the orientation of the spinButton.
`double`	`getPrecision()` Get the precision of the value displayed in the textField.
`java.util.Vector`	`getRequiredInterfaces()` Returns the required interfaces Vector for this component.
`java.lang.Object[]`	`getSelectedObjects()` Get the selected object when the model is a collection.
`long`	`getStartInterval()` Get the start interval for the spinButton alarm to increment the value.
`com.sas.collection.StaticOrderedCollectionInterface`	`getStaticOrderedCollectionModel()` Returns the StaticOrderedCollectionInterface model that is set on the spinBox.
`java.lang.String`	`getText()` Get the text displayed in the textField.
`javax.swing.JTextField`	`getTextField()` Returns the textField that is used in the spinBox.
`int`	`getUnitIncrement()` Get the integer unitIncrement of the spinButton.
`java.lang.Number`	`getUnitIncrementNumber()` Get the unitIncrement number value for the spinButton.
`ValidationInterface`	`getValidator()` Returns the validator being used on the text in the textField of the SpinBox
`int`	`getValue()` Get the integer value of the SpinBox.
`int`	`getVisibleAmount()` Not used.
`protected void`	`handleError()` Internal routine for displaying an error message when text fails the validation rules
`boolean`	`isCycleOn()` Get if the spinButton is set to cycle through its values.
`boolean`	`isDefaultModelAttached()` Returns true if the default model is being used, false otherwise.
`boolean`	`isPrecisionDisplayed()` Get if the text in the textField is displayed correctly.
`void`	`paintComponent(java.awt.Graphics g)` Paint the SpinBox.
`void`	`propertyChange(java.beans.PropertyChangeEvent event)` Handle property change events on complex properties.
`void`	`refresh(com.sas.ModelInterface model)` Refresh the SpinBox with the specified model.
`void`	`removeAdjustmentListener(java.awt.event.AdjustmentListener l)` Remove the adjustment listener.
`void`	`removeItemListener(java.awt.event.ItemListener l)` Remove the item listener.
`void`	`setAlarm(Alarm alarm)` Deprecated.
`void`	`setArrowDirection(int d)` Sets the direction the SpinButton arrows are pointing.
`void`	`setBackground(java.awt.Color color)` Sets the background color of the text field in the SpinBox
`void`	`setBlockIncrement(int block)` Set the blockIncrement on the spinButton.
`void`	`setBlockIncrementNumber(java.lang.Number block)` Set the blockIncrement number value for the spinButton.
`void`	`setColumns(int cols)` Set the number of text columns on the textField.
`void`	`setCycleOn(boolean cycle)` Set the spinButton to cycle through its values.
`static void`	`setDefaultHeight(int newHeight)`
`void`	`setDefaultValues()` Set the default internal values for the BaseButton.
`static void`	`setDefaultWidth(int newWidth)`
`void`	`setDelay(long delay)` Set the delay before the spinButton begins automatically incrementing its value.
`void`	`setDisplayTransform(com.sas.util.transforms.TransformInterface transform)` Set the displayTransform used to transform the items in the model when the model of the SpinBox is a StaticOrderedCollectionInterface object.
`void`	`setDoubleData(double d)` Set the double value of the SpinBox.
`void`	`setEnabled(boolean e)` Set the SpinBox enabled.
`void`	`setErrorHandler(GenericErrorHandlerInterface newErrorHandler)` Set the errorHandler for the validator of the text in the textField of the SpinBox.
`void`	`setForeground(java.awt.Color color)` Sets the foreground color of the text in the SpinBox
`void`	`setMaximum(int max)` Set the integer maximum value for the SpinBox.
`void`	`setMaximumNumber(java.lang.Number max)` Set the maximum number value for the SpinBox.
`void`	`setMinimum(int min)` Set the integer minimum value for the SpinBox.
`void`	`setMinimumNumber(java.lang.Number min)` Set the minimum number value for the SpinBox.
`void`	`setModel(com.sas.models.BoundedNumberInterface model)` Sets the BoundedNumberInterface model on the spinBox.
`void`	`setNumberFormat(java.text.NumberFormat nf)` Set the NumberFormat applied to the value set as the text in the textField.
`void`	`setNumberValue(java.lang.Number value)` Set the number value for the SpinBox.
`void`	`setOrientation(int orient)` Set the orientation of the spinButton.
`void`	`setStartInterval(long startInterval)` Set the start interval for the spinButton alarm to increment the value.
`void`	`setStaticOrderedCollectionModel(com.sas.collection.StaticOrderedCollectionInterface model)` Sets the StaticOrderedCollectionInterface model on the spinBox.
`void`	`setText(java.lang.String txt)` Set the text of the SpinBox.
`void`	`setToolTipText(java.lang.String txt)` Registers the text to display in a tool tip.
`void`	`setUnitIncrement(int unit)` Set the integer value of the unitIncrement.
`void`	`setUnitIncrementNumber(java.lang.Number unit)` Set the unitIncrement number value for the SpinBox.
`void`	`setValidator(ValidationInterface newValidator)` Set the validator for the text in the textField of the SpinBox.
`void`	`setValue(int val)` Set the integer value of the SpinBox.
`void`	`setVisibleAmount(int amt)` Not used.
`protected void`	`updateText(java.lang.Number newValue)` Invoked when the text needs to be updated from a change in the value.
`protected void`	`updateValue(java.lang.String txt)` Invoked when the value needs to be updated from a change in the text.

Field Detail

RB_KEY

public static final java.lang.String RB_KEY

See Also:: Constant Field Values

spinBtn

protected SpinButton spinBtn

text

protected javax.swing.JTextField text

precision

protected double precision

numberFormat

protected java.text.NumberFormat numberFormat

numberFormatSet

protected boolean numberFormatSet

defaultRangeModel

protected com.sas.models.BoundedNumberInterface defaultRangeModel

boundedNumberModel

protected com.sas.models.BoundedNumberInterface boundedNumberModel

staticOrderedCollectionModel

protected com.sas.collection.StaticOrderedCollectionInterface staticOrderedCollectionModel

precisionDisplayed

protected boolean precisionDisplayed

textInvoked

protected transient boolean textInvoked

valueInvoked

protected transient boolean valueInvoked

prefixPredicate

protected transient PrefixPredicate prefixPredicate

arrowKeyAdapter

protected transient com.sas.swing.visuals.SpinBox.ArrowKeyAdapter arrowKeyAdapter

adjustmentListener

protected transient java.awt.event.AdjustmentListener adjustmentListener

itemListener

protected transient java.awt.event.ItemListener itemListener

validator

protected ValidationInterface validator

errorHandler

protected GenericErrorHandlerInterface errorHandler

displayTransform

protected com.sas.util.transforms.TransformInterface displayTransform

UP_DOWN

public static final int UP_DOWN

int values representing the orientation of the spinButton arrows- UP_DOWN

See Also:: Constant Field Values

LEFT_RIGHT

public static final int LEFT_RIGHT

int values representing the orientation of the spinButton arrows- LEFT_RIGHT

See Also:: Constant Field Values

Constructor Detail

SpinBox

public SpinBox()

Default constructor

Method Detail

getDefaultHeight

public static int getDefaultHeight()

getDefaultWidth

public static int getDefaultWidth()

setDefaultHeight

public static void setDefaultHeight(int newHeight)

setDefaultWidth

public static void setDefaultWidth(int newWidth)

getExtendedBeanInfo

public static com.sas.beans.ExtendedBeanInfo getExtendedBeanInfo()

addAdjustmentListener

public void addAdjustmentListener(java.awt.event.AdjustmentListener l)

Add a listener to receive adjustment events when the value of the SpinBox changes.

Specified by:: addAdjustmentListener in interface java.awt.Adjustable

See Also:: Adjustable.addAdjustmentListener(java.awt.event.AdjustmentListener)

addItemListener

public void addItemListener(java.awt.event.ItemListener l)

Add a listener to receive item events when the state of the SpinBox changes.

Specified by:: addItemListener in interface java.awt.ItemSelectable

See Also:: ItemSelectable.addItemListener(java.awt.event.ItemListener)

adjustmentValueChanged

public void adjustmentValueChanged(java.awt.event.AdjustmentEvent e)

Handle all adjustment events that are sent out by spinButton. Forward the events on to the AdjustmentListeners.

Specified by:: adjustmentValueChanged in interface java.awt.event.AdjustmentListener

contentsChanged

public void contentsChanged(com.sas.collection.ContentsChangedEvent e)

Handle contentsChanged events from a collection model.

Specified by:: contentsChanged in interface com.sas.collection.ContentsChangedListener

setToolTipText

public void setToolTipText(java.lang.String txt)

Registers the text to display in a tool tip. The text displays when the cursor lingers over the spinBox for a set time period.

Overrides:: setToolTipText in class javax.swing.JComponent

Parameters:: txt - the string to display; if the text is null, the tool tip is turned off for this component

isDefaultModelAttached

public boolean isDefaultModelAttached()

Returns true if the default model is being used, false otherwise.

Returns:: true if the default model is being used, false otherwise.
See Also:: ViewDefaultModel

getModel

public com.sas.models.BoundedNumberInterface getModel()

Returns the BoundedNumberInterface model that is set on the spinBox.

Returns:: the BoundedNumberInterface model, null if not set.

setModel

public void setModel(com.sas.models.BoundedNumberInterface model)

Sets the BoundedNumberInterface model on the spinBox. Pass in null to dettach the model.

Parameters:: the - model to set, null to dettach the model

getStaticOrderedCollectionModel

public com.sas.collection.StaticOrderedCollectionInterface getStaticOrderedCollectionModel()

Returns the StaticOrderedCollectionInterface model that is set on the spinBox.

Returns:: the StaticOrderedCollectionInterface model, null if not set.

setStaticOrderedCollectionModel

public void setStaticOrderedCollectionModel(com.sas.collection.StaticOrderedCollectionInterface model)

Sets the StaticOrderedCollectionInterface model on the spinBox. Pass in null to dettach the model.

Parameters:: the - model to set, null to dettach the model

paintComponent

public void paintComponent(java.awt.Graphics g)

Paint the SpinBox.

Overrides:: paintComponent in class javax.swing.JComponent

Parameters:: g - the graphics context

setForeground

public void setForeground(java.awt.Color color)

Sets the foreground color of the text in the SpinBox

Overrides:: setForeground in class javax.swing.JComponent

Parameters:: color - the new color for the text in the SpinBox

setBackground

public void setBackground(java.awt.Color color)

Sets the background color of the text field in the SpinBox

Overrides:: setBackground in class javax.swing.JComponent

Parameters:: color - the new color for the text field in the SpinBox

getAlarm

public Alarm getAlarm()

Deprecated.

Get the alarm used to trigger the spinButton when it is pressed and held down.

Returns:: the alarm set on the spinButton
See Also:: SpinButton.getAlarm(), setAlarm(com.sas.util.Alarm)

getArrowDirection

public int getArrowDirection()

Get the direction the SpinButton arrows are pointing.

Returns:: the UP_DOWN or the LEFT_RIGHT values.
See Also:: setArrowDirection(int)

getDelay

public long getDelay()

Get the delay before the spinButton begins automatically incrementing its value. The delay is in milliseconds.

Returns:: the delay before the spinButton begins incrementing its value.
See Also:: getStartInterval(), setDelay(long)

getStartInterval

public long getStartInterval()

Get the start interval for the spinButton alarm to increment the value. The alarm interval gets shorter the longer the alarm is fired( the longer the button is held down).

Returns:: the start interval between spinButton value increments.
See Also:: getDelay(), setStartInterval(long)

getBlockIncrement

public int getBlockIncrement()

Get the block value increment for the spinButton. This may not equal the blockIncrementNumber value if the number value is not using an integer data type.

Specified by:: getBlockIncrement in interface java.awt.Adjustable

See Also:: Adjustable, SpinButton, getBlockIncrementNumber(), setBlockIncrement(int)

getColumns

public int getColumns()

Get the number of columns of the textField.

Returns:: the number of columns of the textField
See Also:: setColumns(int)

getDisplayTransform

public com.sas.util.transforms.TransformInterface getDisplayTransform()

Get the displayTransform used to transform the objects in the model before they are displayed.

Returns:: the display TransformInterface object

getDoubleData

public final double getDoubleData()

Get the double data value of the SpinBox. Final method that calls the getNumberValue() method.

Specified by:: getDoubleData in interface com.sas.lang.DoubleDataInterface

Returns:: double value of the SpinBox
See Also:: setDoubleData(double), getNumberValue(), DoubleDataInterface

getMaximum

public int getMaximum()

Get the maximum integer value of the SpinBox. This may not equal the maximumNumber value if the number value is not using an integer data type.

Specified by:: getMaximum in interface java.awt.Adjustable

Returns:: the maximum value of the SpinBox.
See Also:: Adjustable, getMaximumNumber(), setMaximum(int)

getMinimum

public int getMinimum()

Get the minimum integer value of the SpinBox. This may not equal the minimumNumber value if the number value is not using an integer data type.

Specified by:: getMinimum in interface java.awt.Adjustable

Returns:: the minimum value of the SpinBox.
See Also:: Adjustable, getMinimumNumber(), setMinimum(int)

getBlockIncrementNumber

public java.lang.Number getBlockIncrementNumber()

Get the blockIncrement number value for the spinButton.

See Also:: Adjustable, SpinButton, setBlockIncrement(int)

getMaximumNumber

public java.lang.Number getMaximumNumber()

Get the maximum number value for the SpinBox.

Returns:: the maximum number value for the SpinBox
See Also:: BoundedNumberInterface, setMaximumNumber(java.lang.Number)

getMinimumNumber

public java.lang.Number getMinimumNumber()

Get the minimum number value for the SpinBox.

Returns:: the minimum number value for the SpinBox
See Also:: BoundedNumberInterface, setMinimumNumber(java.lang.Number)

getRequiredInterfaces

public java.util.Vector getRequiredInterfaces()

Returns the required interfaces Vector for this component.

Returns:: the required interfaces Vector for this component.
See Also:: ViewInterface.getRequiredInterfaces()

getUnitIncrementNumber

public java.lang.Number getUnitIncrementNumber()

Get the unitIncrement number value for the spinButton.

See Also:: Adjustable, SpinButton, setBlockIncrement(int)

getNumberValue

public java.lang.Number getNumberValue()

Get the number value of the SpinBox.

Returns:: the number value of the SpinBox
See Also:: setNumberValue(java.lang.Number)

getNumberFormat

public java.text.NumberFormat getNumberFormat()

Get the NumberFormat applied to the value set as the text in the textField. This allows for formating of the string displayed in the textField.

Returns:: the NumberFormat object used to format the value set as the text in the textField
See Also:: NumberFormat

getOrientation

public int getOrientation()

Get the orientation of the spinButton.

Specified by:: getOrientation in interface java.awt.Adjustable

Returns:: an orientation value from java.awt.Adjustable
See Also:: Adjustable, SpinButton, setOrientation(int)

getPrecision

public double getPrecision()

Get the precision of the value displayed in the textField.

Returns:: the precision for the display of the SpinBox value

getSelectedObjects

public java.lang.Object[] getSelectedObjects()

Get the selected object when the model is a collection.

Specified by:: getSelectedObjects in interface java.awt.ItemSelectable

Returns:: a one-element array containing the selectedItem when the model is a collection, null otherwise.
See Also:: ItemSelectable

getText

public java.lang.String getText()

Get the text displayed in the textField.

Specified by:: getText in interface com.sas.lang.StringDataInterface

Returns:: the text displayed in the textField
See Also:: StringDataInterface, setText(java.lang.String)

getTextField

public javax.swing.JTextField getTextField()

Returns the textField that is used in the spinBox. Allows the user to get the textField and then make modifications to it like setting the document on it. Validation of input in the textField can be done this way.

Returns:: the textField component in the spinBox

getIncrementButton

public javax.swing.JButton getIncrementButton()

Returns the button that is used to increment in the spinBox. Allows the user to set an ActionListener on it.

Returns:: the increment button in the spinBox

getDecrementButton

public javax.swing.JButton getDecrementButton()

Returns the button that is used to deccrement in the spinBox. Allows the user to set an ActionListener on it.

Returns:: the decrement button in the spinBox

getUnitIncrement

public int getUnitIncrement()

Get the integer unitIncrement of the spinButton. This may not equal the unitIncrementNumber value if the number value is not using an integer data type.

Specified by:: getUnitIncrement in interface java.awt.Adjustable

Returns:: the amount the value is incremented by the spinButton.
See Also:: setUnitIncrement(int)

getValue

public int getValue()

Get the integer value of the SpinBox.

Specified by:: getValue in interface java.awt.Adjustable

Returns:: the integer value of the SpinBox
See Also:: Adjustable, SpinButton, setValue(int)

getVisibleAmount

public int getVisibleAmount()

Not used. Get the visibleAmount of the spinButton.

Specified by:: getVisibleAmount in interface java.awt.Adjustable

Returns:: the visibleAmount
See Also:: Adjustable, setVisibleAmount(int)

isCycleOn

public boolean isCycleOn()

Get if the spinButton is set to cycle through its values.

Returns:: true if the values will be cycled through; false otherwise.
See Also:: setCycleOn(boolean)

isPrecisionDisplayed

public boolean isPrecisionDisplayed()

Get if the text in the textField is displayed correctly.

Returns:: if the text uses the precision to display the value.

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)

Handles the action performed events on the textField in the spinBox. Sets the text and value of the spinBox.

Specified by:: actionPerformed in interface java.awt.event.ActionListener

Parameters:: the - action performed event on the textField

focusGained

public void focusGained(java.awt.event.FocusEvent e)

Handles the focus gained events on the textField in the spinBox. Does nothing.

Specified by:: focusGained in interface java.awt.event.FocusListener

Parameters:: the - focus gained event

focusLost

public void focusLost(java.awt.event.FocusEvent e)

Handles the focus lost event on the textField in the spinBox. Sets the text and value of the spinBox.

Specified by:: focusLost in interface java.awt.event.FocusListener

Parameters:: the - focus lost event on the textField

propertyChange

public void propertyChange(java.beans.PropertyChangeEvent event)

Handle property change events on complex properties.

Specified by:: propertyChange in interface java.beans.PropertyChangeListener

refresh

public void refresh(com.sas.ModelInterface model)

Refresh the SpinBox with the specified model.

Parameters:: model - the model to refresh the SpinBox with.

removeAdjustmentListener

public void removeAdjustmentListener(java.awt.event.AdjustmentListener l)

Remove the adjustment listener.

Specified by:: removeAdjustmentListener in interface java.awt.Adjustable

Parameters:: l - the adjustment listener
See Also:: addAdjustmentListener(java.awt.event.AdjustmentListener), AdjustmentEvent

removeItemListener

public void removeItemListener(java.awt.event.ItemListener l)

Remove the item listener.

Specified by:: removeItemListener in interface java.awt.ItemSelectable

Parameters:: l - the item listener
See Also:: addItemListener(java.awt.event.ItemListener), ItemEvent

setAlarm

public void setAlarm(Alarm alarm)

Deprecated.

Set the alarm used to trigger the spinButton when it is held down.

Parameters:: alarm - the spinButton alarm
See Also:: SpinButton.setAlarm(com.sas.util.Alarm)

setArrowDirection

public void setArrowDirection(int d)

Sets the direction the SpinButton arrows are pointing.

Parameters:: d - the UP_DOWN or the LEFT_RIGHT values.
See Also:: getArrowDirection()

setBlockIncrement

public void setBlockIncrement(int block)

Set the blockIncrement on the spinButton.

Specified by:: setBlockIncrement in interface java.awt.Adjustable

See Also:: Adjustable, SpinButton, getBlockIncrement()

setColumns

public void setColumns(int cols)

Set the number of text columns on the textField.

Parameters:: cols - the number of columns of text

setCycleOn

public void setCycleOn(boolean cycle)

Set the spinButton to cycle through its values.

Parameters:: cycle - true if the values will be cycled through; false otherwise.
See Also:: isCycleOn()

setDefaultValues

public void setDefaultValues()

Set the default internal values for the BaseButton.

setDelay

public void setDelay(long delay)

Set the delay before the spinButton begins automatically incrementing its value. The delay is in milliseconds.

Parameters:: delay - the delay before the spinButton begins incrementing its value.
See Also:: getDelay()

setStartInterval

public void setStartInterval(long startInterval)

Set the start interval for the spinButton alarm to increment the value. The alarm interval gets shorter the longer the alarm is fired( the longer the button is held down).

Parameters:: startInterval - the start interval between spinButton value increments.
See Also:: getStartInterval()

setDisplayTransform

public void setDisplayTransform(com.sas.util.transforms.TransformInterface transform)

Set the displayTransform used to transform the items in the model when the model of the SpinBox is a StaticOrderedCollectionInterface object. The transformed items are displayed in the textField.

Parameters:: transform - the displayTransform

setDoubleData

public final void setDoubleData(double d)

Set the double value of the SpinBox. Final method that calls the setNumberValue(Number) method.

Specified by:: setDoubleData in interface com.sas.lang.DoubleDataInterface

Parameters:: d - new double value
See Also:: getDoubleData(), setNumberValue(java.lang.Number), DoubleDataInterface

setEnabled

public void setEnabled(boolean e)

Set the SpinBox enabled.

Overrides:: setEnabled in class javax.swing.JComponent

Parameters:: e - true to enable the SpinBox; false to disable it

setMaximum

public void setMaximum(int max)

Set the integer maximum value for the SpinBox.

Specified by:: setMaximum in interface java.awt.Adjustable

Parameters:: max - the integer maximum value
See Also:: getMaximum()

setMinimum

public void setMinimum(int min)

Set the integer minimum value for the SpinBox.

Specified by:: setMinimum in interface java.awt.Adjustable

Parameters:: min - the integer minimum value
See Also:: getMinimum()

setBlockIncrementNumber

public void setBlockIncrementNumber(java.lang.Number block)

Set the blockIncrement number value for the spinButton.

See Also:: Adjustable, SpinButton, setBlockIncrement(int)

setMaximumNumber

public void setMaximumNumber(java.lang.Number max)

Set the maximum number value for the SpinBox.

Parameters:: max - the maximum number value for the SpinBox
See Also:: BoundedNumberInterface, getMaximumNumber()

setMinimumNumber

public void setMinimumNumber(java.lang.Number min)

Set the minimum number value for the SpinBox.

Parameters:: min - the minimum number value for the SpinBox
See Also:: BoundedNumberInterface, getMinimumNumber()

setUnitIncrementNumber

public void setUnitIncrementNumber(java.lang.Number unit)

Set the unitIncrement number value for the SpinBox.

Parameters:: unit - the unitIncrement number value for the SpinBox
See Also:: BoundedNumberInterface, getUnitIncrementNumber()

setNumberValue

public void setNumberValue(java.lang.Number value)

Set the number value for the SpinBox.

Parameters:: value - the number value for the SpinBox
See Also:: BoundedNumberInterface, getNumberValue()

setNumberFormat

public void setNumberFormat(java.text.NumberFormat nf)

Set the NumberFormat applied to the value set as the text in the textField. This allows for formating of the number value displayed in the textField.

Parameters:: nf - the NumberFormat object used to format the value set as the text in the textField
See Also:: NumberFormat

setOrientation

public void setOrientation(int orient)

Set the orientation of the spinButton. Uses HORIZONTAL and VERTICAL static int values.

Parameters:: orient - an orientation value from java.awt.Adjustable
See Also:: Adjustable, getOrientation()

setText

public void setText(java.lang.String txt)

Set the text of the SpinBox. This also changes the value if the model is a boundedNumber

Specified by:: setText in interface com.sas.lang.StringDataInterface

Parameters:: txt - the new text of the SpinBox
See Also:: getText()

handleError

protected void handleError()

Internal routine for displaying an error message when text fails the validation rules

See Also:: setValidator(com.sas.util.validators.ValidationInterface), setErrorHandler(com.sas.util.errorhandlers.GenericErrorHandlerInterface)

setUnitIncrement

public void setUnitIncrement(int unit)

Set the integer value of the unitIncrement.

Specified by:: setUnitIncrement in interface java.awt.Adjustable

Parameters:: unit - the new unitIncrement.
See Also:: Adjustable, getUnitIncrement()

setValue

public void setValue(int val)

Set the integer value of the SpinBox.

Specified by:: setValue in interface java.awt.Adjustable

Parameters:: val - the new integer value
See Also:: Adjustable, getValue()

setValidator

public void setValidator(ValidationInterface newValidator)

Set the validator for the text in the textField of the SpinBox. If a model is set the implements the ValidationInterface, this property will be set with the model. This property must be set after the model if a different validator is wanted. If this is set before the model is set, it will be overridden if the model implements the ValidationInterface.

getValidator

public ValidationInterface getValidator()

Returns the validator being used on the text in the textField of the SpinBox

Returns:: the validator for the text in the textField

setErrorHandler

public void setErrorHandler(GenericErrorHandlerInterface newErrorHandler)

Set the errorHandler for the validator of the text in the textField of the SpinBox.

getErrorHandler

public GenericErrorHandlerInterface getErrorHandler()

Returns the error handler being used for the validator on the text in the textField of the SpinBox

Returns:: the error handler for the validator

setVisibleAmount

public void setVisibleAmount(int amt)

Not used. Required for the java.awt.Adjustable interface.

Specified by:: setVisibleAmount in interface java.awt.Adjustable

See Also:: Adjustable

updateText

protected void updateText(java.lang.Number newValue)

Invoked when the text needs to be updated from a change in the value.

updateValue

protected void updateValue(java.lang.String txt)

Invoked when the value needs to be updated from a change in the text.

All Libraries

This Library

Package

Class

Use

Tree

Deprecated

Index

Grand Index

Help

Components

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.sas.swing.visuals Class SpinBox