Package docking.widgets.values

Class LongValue

java.lang.Object

docking.widgets.values.AbstractValue<Long>

docking.widgets.values.LongValue

public class LongValue
extends AbstractValue<Long>

Value class for Long Values with an option for display the value as decimal or hex. The editor component uses an IntegerTextField for display and editing the value. This value supports the concept of no value which is represented by the text field being empty. If the text field is not empty, then the field only allows valid numeric values.

This class and other subclasses of AbstractValue are part of a subsystem for easily defining a set of values that can be displayed in an input dialog (ValuesMapDialog). Typically, these values are created indirectly using a GValuesMap which is then given to the constructor of the dialog. However, an alternate approach is to create the dialog without a ValuesMap and then use its ValuesMapDialog.addValue(AbstractValue) method directly.

Constructor Summary

Constructors

Constructor	Description
LongValue(String name)
LongValue(String name, boolean displayAsHex)
LongValue(String name, Long defaultValue)
LongValue(String name, Long defaultValue, boolean displayAsHex)

Method Summary

Modifier and Type	Method	Description
Long	fromString(String valueString)	Parses the given string into a value of type T
String	getAsText()	Returns a string representation for the value.
JComponent	getComponent()	Returns a JComponent for entering or editing a value of this type.
protected void	updateComponentFromValue()	Updates the JComponent returned from AbstractValue.getComponent() to represent the current value of this object.
protected void	updateValueFromComponent()	Causes the stored value for this object to be updated based on the state of the JComponent returned from AbstractValue.getComponent()

Methods inherited from class docking.widgets.values.AbstractValue

copyValue, getName, getValue, hasValue, reset, setAsText, setValue, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

LongValue

public LongValue(String name)

LongValue

public LongValue(String name,
 Long defaultValue)

LongValue

public LongValue(String name,
 boolean displayAsHex)

LongValue

public LongValue(String name,
 Long defaultValue,
 boolean displayAsHex)

Method Details

getComponent

public JComponent getComponent()

Description copied from class: AbstractValue

Returns a JComponent for entering or editing a value of this type.

Specified by:

getComponent in class AbstractValue<Long>

Returns:

a JComponent for entering or editing a value of this type.

updateValueFromComponent

protected void updateValueFromComponent()

Description copied from class: AbstractValue

Causes the stored value for this object to be updated based on the state of the JComponent returned from AbstractValue.getComponent()

Specified by:

updateValueFromComponent in class AbstractValue<Long>

updateComponentFromValue

protected void updateComponentFromValue()

Description copied from class: AbstractValue

Updates the JComponent returned from AbstractValue.getComponent() to represent the current value of this object.

Specified by:

updateComponentFromValue in class AbstractValue<Long>

fromString

public Long fromString(String valueString)

Description copied from class: AbstractValue

Parses the given string into a value of type T

Specified by:

fromString in class AbstractValue<Long>

Parameters:

valueString - the string to parse

Returns:

a value of type T

getAsText

public String getAsText()

Description copied from class: AbstractValue

Returns a string representation for the value. It is expected that the string returned from this method can be parsed by the corresponding AbstractValue.setAsText(String) method. If the value of this object is null, null will be returned.

Overrides:

getAsText in class AbstractValue<Long>

Returns:

a string representation for the value or null if the value is null