All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class jclass.bwt.JCSpinBox

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.Container
                   |
                   +----java.awt.Panel
                           |
                           +----jclass.bwt.JCContainer
                                   |
                                   +----jclass.bwt.JCSpinBox

public class JCSpinBox

extends JCContainer

implements JCActionListener

By default, the text field is editable. If the user attempts to enter an invalid value, it is disallowed.

Properties

Name	Method
AutoArrowDisable	setAutoArrowDisable
Background	setBackground
DecimalPlaces	setDecimalPlaces
DoubleBuffer	setDoubleBuffer
Font	setFont
Foreground	setForeground
Increment	setIncrement
Insets	setInsets
Maximum	setMaximum
Minimum	setMinimum
Position	setPosition
PreferredSize	setPreferredSize
UserData	setUserData

Events

Class	Listener	Description
JCSpinBoxEvent	addSpinBoxListener	Posted when the user changes the value

auto_arrow_disable

decimals

decr_arrow

DECREMENT

incr

incr_arrow

INCREMENT

listeners

List of JCSpinBoxEvent listeners

max

min

NONE

position

shadow

The container's shadow thickness.

text

value

JCSpinBox()

Creates an empty SpinBox.

JCSpinBox(Applet, String)

Creates a SpinBox which reads parameters from the applet's HTML file.

JCSpinBox(int)

Creates an empty SpinBox with the specified number of columns.

actionPerformed(JCActionEvent)

If an arrow button was pressed, calls setTextAction.
If the user changed the text field's value, calls validate.

addSpinBoxListener(JCSpinBoxListener)

Adds the specified JCSpinBoxEvent listener to receive value change events.

calcValue(int)

Gets the value to be displayed

enableArrowButtons()

Disables the arrow buttons if the end of the range is reached.

getAutoArrowDisable()

Gets the AutoArrowDisable value.

getDecimalPlaces()

Gets the DecimalPlaces value.

getDecimalPointChar()

Gets the decimal point char.

getDecrementArrow()

Gets the decrement (down) button.

getIncrement()

Gets the Increment value.

getIncrementArrow()

Gets the increment (up) button.

getIntValue()

Gets the current value as an int.

getMaximum()

Gets the Maximum value.

getMinimum()

Gets the Minimum value.

getParameters()

Reads the parameter values from the HTML page using the component's applet.

getPosition()

Gets the Position value.

getText()

Gets the value of the text.

getTextField()

Gets the component to be used as the data entry field.

getValue()

Gets the current value as a string.

initTextValue()

Sets the text field's initial value.

layout()

Positions the text field and arrow buttons.

paintInterior(Graphics)

Draws the shadows.

postSpinBoxEvent(int, Object)

Posts a JCSpinBoxEvent

preferredHeight()

Returns the text field's preferred height.

preferredWidth()

Returns the sum of the text field's and arrow button's preferred widths.

removeSpinBoxListener(JCSpinBoxListener)

Removes the specified listener so it no longer receives JCSpinBoxEvents.

setAutoArrowDisable(boolean)

If true (default), the increment or decrement arrow button is disabled when the end of the range is reached.

setDecimalPlaces(int)

Sets the number of decimal points used when displaying the value (default: 0).

HTML param name/value: "DecimalPlaces"/int

setIncrement(int)

Sets the amount by which to increment or decrement the value (default: 1).

HTML param name/value: "Increment"/int

setIntValue(int)

Sets the current value as an int.

setLayout(LayoutManager)

Sets the layout manager for this container.

setMaximum(int)

Sets the highest possible value (default: BWTEnum.MAXINT).

HTML param name/value: "Maximum"/int

setMinimum(int)

Sets the lowest possible value (default: 0).

HTML param name/value: "Minimum"/int

setPosition(int)

Sets the position of the currently displayed item (default: 0) (the position in the range of possible values).

setText(String)

Sets the text field's value to the specified string.

HTML param name/value: "Text"/string

setTextAction(int)

Sets the text field's value after an arrow key is hit.

setTextValue(Object)

Sets the text field's value.

validate(Object)

Validates the text field's value after the user has changed it.

validateKey(char)

Validates a key typed into the text field.

 protected SpinField text

 protected JCArrowButton decr_arrow

 protected JCArrowButton incr_arrow

 protected int position

 protected int min

 protected int max

 protected int incr

 protected int decimals

 protected Object value

 protected boolean auto_arrow_disable

 protected int shadow

The container's shadow thickness.

 protected static final int NONE

 protected static final int INCREMENT

 protected static final int DECREMENT

 protected JCVector listeners

List of JCSpinBoxEvent listeners

 public JCSpinBox()

Creates an empty SpinBox. No parameters are read from an HTML file.

 public JCSpinBox(int cols)

Creates an empty SpinBox with the specified number of columns. No parameters are read from an HTML file.

 public JCSpinBox(Applet applet,
                  String name)

Creates a SpinBox which reads parameters from the applet's HTML file.

Parameters:

applet - the applet whose PARAM tags are to be read

name - if this is not null, only parameters preceded by this name are read

See Also:

getParameter

 protected void getParameters()

Reads the parameter values from the HTML page using the component's applet. The values will override those previously set.

Overrides:

getParameters in class JCContainer

 public JCTextField getTextField()

Gets the component to be used as the data entry field.

 public JCArrowButton getDecrementArrow()

Gets the decrement (down) button.

 public JCArrowButton getIncrementArrow()

Gets the increment (up) button.

 public boolean getAutoArrowDisable()

Gets the AutoArrowDisable value.

See Also:

setAutoArrowDisable

 public void setAutoArrowDisable(boolean v)

If true (default), the increment or decrement arrow button is disabled when the end of the range is reached. If set to false, the buttons are always enabled.

HTML param name/value: "AutoArrowDisable"/boolean

 public int getDecimalPlaces()

Gets the DecimalPlaces value.

See Also:

setDecimalPlaces

 public void setDecimalPlaces(int v)

Sets the number of decimal points used when displaying the value (default: 0).

HTML param name/value: "DecimalPlaces"/int

 public int getIncrement()

Gets the Increment value.

See Also:

setIncrement

 public void setIncrement(int v)

Sets the amount by which to increment or decrement the value (default: 1).

HTML param name/value: "Increment"/int

 public int getMinimum()

Gets the Minimum value.

See Also:

setMinimum

 public void setMinimum(int v)

Sets the lowest possible value (default: 0).

HTML param name/value: "Minimum"/int

 public int getMaximum()

Gets the Maximum value.

See Also:

setMaximum

 public void setMaximum(int v)

Sets the highest possible value (default: BWTEnum.MAXINT).

HTML param name/value: "Maximum"/int

 public int getPosition()

Gets the Position value.

See Also:

setPosition

 public void setPosition(int v)

Sets the position of the currently displayed item (default: 0) (the position in the range of possible values). HTML param name/value: "Position"/int

 public int getIntValue()

Gets the current value as an int.

 public void setIntValue(int v)

Sets the current value as an int.

 public String getValue()

Gets the current value as a string.

 public synchronized void setText(String s)

Sets the text field's value to the specified string.

HTML param name/value: "Text"/string

 public synchronized String getText()

Gets the value of the text.

See Also:

setText

 public void addSpinBoxListener(JCSpinBoxListener l)

Adds the specified JCSpinBoxEvent listener to receive value change events.

See Also:

JCSpinBoxEvent

 public void removeSpinBoxListener(JCSpinBoxListener l)

Removes the specified listener so it no longer receives JCSpinBoxEvents.

See Also:

addSpinBoxListener

 protected int preferredWidth()

Returns the sum of the text field's and arrow button's preferred widths.

Overrides:

preferredWidth in class JCContainer

 protected int preferredHeight()

Returns the text field's preferred height.

Overrides:

preferredHeight in class JCContainer

 public synchronized void layout()

Positions the text field and arrow buttons.

Overrides:

layout in class Container

 public void paintInterior(Graphics gc)

Draws the shadows.

Overrides:

paintInterior in class JCContainer

 protected JCSpinBoxEvent postSpinBoxEvent(int stage,
                                           Object value)

Posts a JCSpinBoxEvent

Returns:

the posted event, or null if there are no listeners

See Also:

addSpinBoxListener, JCSpinBoxEvent

 protected char getDecimalPointChar()

Gets the decimal point char.

 protected Object calcValue(int dir)

Gets the value to be displayed

Parameters:

dir - INCREMENT, DECREMENT or NONE

 protected void initTextValue()

Sets the text field's initial value.

 protected void setTextValue(Object value)

Sets the text field's value.

 public void setTextAction(int dir)

Sets the text field's value after an arrow key is hit.

Parameters:

dir - INCREMENT, DECREMENT or NONE

 protected void enableArrowButtons()

Disables the arrow buttons if the end of the range is reached.

See Also:

setAutoArrowDisable

 protected boolean validateKey(char key)

Validates a key typed into the text field.

Returns:

false if the key is invalid

 protected boolean validate(Object value)

Validates the text field's value after the user has changed it. If the value is valid, the position is determined.

Returns:

false if the value is invalid

See Also:

setPosition

 public void actionPerformed(JCActionEvent ev)

If an arrow button was pressed, calls setTextAction.
If the user changed the text field's value, calls validate.

See Also:

setTextAction, validate

 public final void setLayout(LayoutManager mgr)

Sets the layout manager for this container. This method is overridden to prevent the layout mgr from being set.

Overrides:

setLayout in class Container

All Packages  Class Hierarchy  This Package  Previous  Next  Index