Package adams.data

Class DateFormatString

java.lang.Object

adams.core.base.BaseObject

adams.core.base.AbstractBaseString

adams.data.DateFormatString

All Implemented Interfaces:

CloneHandler<BaseObject>, HelpProvider, Serializable, Comparable

public class DateFormatString
extends AbstractBaseString
implements HelpProvider

Wrapper for date/time formats.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields inherited from class adams.core.base.BaseObject

m_Internal, m_Properties, SUFFIX_DISPLAY, SUFFIX_VALUE

Constructor Summary

Constructors

Constructor	Description
DateFormatString()	Initializes the string with Constants.DATE_FORMAT.
DateFormatString(String s)	Initializes the object with the string to parse.

Method Summary

Modifier and Type	Method	Description
String	getHelpDescription()	Returns a long help description, e.g., used in tiptexts.
String	getHelpIcon()	Returns the name of a help icon, e.g., used for buttons.
String	getHelpTitle()	Returns a short title for the help, e.g., used for buttons.
String	getHelpURL()	Returns a URL with additional information.
String	getTipText()	Returns a tool tip for the GUI editor (ignored if null is returned).
boolean	hasFavoritesSupport()	Whether this object should have favorites support.
protected void	initialize()	Initializes the internal object.
boolean	isValid(String value)	Checks whether the string value is a valid presentation for this class.
DateFormat	toDateFormat()	Returns a configured DateFormat object.
DateFormat	toDateFormat(TimeZone tz)	Returns a configured DateFormat object.

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, hashCode, isValidUnicode, newInstance, setUnicode, toObjectArray, toObjectArray, toString, toStringArray, toStringList

Methods inherited from class java.lang.Object

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

Constructor Detail

DateFormatString

public DateFormatString()

Initializes the string with Constants.DATE_FORMAT.

DateFormatString

public DateFormatString(String s)

Initializes the object with the string to parse.

Parameters:

s - the string to parse

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:

always true

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

toDateFormat

public DateFormat toDateFormat()

Returns a configured DateFormat object.

Returns:

the configured object

toDateFormat

public DateFormat toDateFormat(TimeZone tz)

Returns a configured DateFormat object.

Parameters:

tz - the timezone to use

Returns:

the configured object

getHelpURL

public String getHelpURL()

Returns a URL with additional information.

Specified by:

getHelpURL in interface HelpProvider

Returns:

the URL, null if not available

getHelpDescription

public String getHelpDescription()

Returns a long help description, e.g., used in tiptexts.

Specified by:

getHelpDescription in interface HelpProvider

Returns:

the help text, null if not available

getHelpTitle

public String getHelpTitle()

Returns a short title for the help, e.g., used for buttons.

Specified by:

getHelpTitle in interface HelpProvider

Returns:

the short title, null if not available

getHelpIcon

public String getHelpIcon()

Returns the name of a help icon, e.g., used for buttons.

Specified by:

getHelpIcon in interface HelpProvider

Returns:

the icon name, null if not available

hasFavoritesSupport

public boolean hasFavoritesSupport()

Whether this object should have favorites support.

Overrides:

hasFavoritesSupport in class BaseObject

Returns:

true if to support favorites