Package adams.core.base

Class BaseDimension

java.lang.Object

adams.core.base.BaseObject

adams.core.base.AbstractBaseString

adams.core.base.BaseDimension

All Implemented Interfaces:

CloneHandler<BaseObject>, Serializable, Comparable

public class BaseDimension
extends AbstractBaseString

Wrapper for a Dimension object to be editable in the GOE. Format: width;height

Version:

$Revision: 10214 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT	the default value.
static String	SEPARATOR	the separator.

Fields inherited from class adams.core.base.BaseObject

m_Internal, m_Properties, SUFFIX_DISPLAY, SUFFIX_VALUE

Constructor Summary

Constructors

Constructor	Description
BaseDimension()	Initializes the string with length 0.
BaseDimension(int width, int height)	Initializes the object with the given value.
BaseDimension(Dimension value)	Initializes the object with the given value.
BaseDimension(String s)	Initializes the object with the string to parse.

Method Summary

Modifier and Type	Method	Description
Dimension	dimensionValue()	Returns the Dimension value.
String	getTipText()	Returns a tool tip for the GUI editor (ignored if null is returned).
protected void	initialize()	Initializes the internal object.
boolean	isValid(String value)	Checks whether the string value is a valid presentation for this class.
Dimension	parse(String s)	Parses the string ("width;height").
static String	toString(Dimension d)	Turns a Dimension object into a string.

Methods inherited from class adams.core.base.AbstractBaseString

convert, getValue, isEmpty, length, setValue, stringValue

Methods inherited from class adams.core.base.BaseObject

compareTo, equals, getClone, getInternal, getTemplates, getUnicode, hasFavoritesSupport, hashCode, isValidUnicode, newInstance, setUnicode, toObjectArray, toObjectArray, toString, toStringArray, toStringList

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SEPARATOR

public static final String SEPARATOR

the separator.

See Also:

Constant Field Values

DEFAULT

public static final String DEFAULT

the default value.

See Also:

Constant Field Values

Constructor Detail

BaseDimension

public BaseDimension()

Initializes the string with length 0.

BaseDimension

public BaseDimension(String s)

Initializes the object with the string to parse.

Parameters:

s - the string to parse

BaseDimension

public BaseDimension(Dimension value)

Initializes the object with the given value.

Parameters:

value - the value to use

BaseDimension

public BaseDimension(int width,
                     int height)

Initializes the object with the given value.

Parameters:

width - the width

height - the height

Method Detail

initialize

protected void initialize()

Initializes the internal object.

Overrides:

initialize in class AbstractBaseString

isValid

public boolean isValid(String value)

Checks whether the string value is a valid presentation for this class.

Overrides:

isValid in class AbstractBaseString

Parameters:

value - the string value to check

Returns:

true if parseable boolean

dimensionValue

public Dimension dimensionValue()

Returns the Dimension value.

Returns:

the Dimension value

getTipText

public String getTipText()

Returns a tool tip for the GUI editor (ignored if null is returned).

Specified by:

getTipText in class AbstractBaseString

Returns:

the tool tip

toString

public static String toString(Dimension d)

Turns a Dimension object into a string.

Parameters:

d - the object to convert

Returns:

the generated string

parse

public Dimension parse(String s)

Parses the string ("width;height").

Parameters:

s - the string to parse

Returns:

the generated Dimension object, null if failed to parse