com.dpslink.base.html

Class Option

java.lang.Object

com.dpslink.base.obj.MappedAttributesObject

com.dpslink.base.html.Option

All Implemented Interfaces:

java.io.Serializable

public class Option
extends MappedAttributesObject

Defines an HTML option for a select form field. Because an HTML option is not a standalone form field, it does not have attributes or behaviors similar to other form fields. This class therefore intentionally does not extend AbstractField.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	OPTION The pattern used to create the html for a select option.
private static long	serialVersionUID The class' serialization version id.

Fields inherited from class com.dpslink.base.obj.MappedAttributesObject

ivHashCode, ivHashFlds, ivObjAttrs

Constructor Summary

Constructors

Constructor and Description
Option(java.lang.String text) Constructs a new instance of Option using the supplied parameters.
Option(java.lang.String text, java.lang.String value) Constructs a new instance of Option using the supplied parameters.
Option(java.lang.String text, java.lang.String value, boolean selected) Constructs a new instance of Option using the supplied parameters.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Compares the given object to this object and determines if the two are equal.
private java.lang.String	formatAttr(java.lang.String attr) Returns a formatted html string for the requested attribute value.
boolean	getSelected() Returns the option's selected state attribute.
java.lang.String	getText() Returns the option's text attribute.
java.lang.String	getValue() Returns the option's value attribute.
void	setSelected(boolean selected) Sets the option's selected state attribute.
void	setText(java.lang.String text) Sets the option's text attribute.
void	setTextHS(java.lang.String text) Sets the option's text attribute.
void	setValue(java.lang.String value) Sets the option's value attribute.
java.lang.String	toHTML() Returns a formatted html string for the option's current attribute values.

Methods inherited from class com.dpslink.base.obj.MappedAttributesObject

cloneMapAttributes, formatValue, formatValue, getHashFields, getMapArrayList, getMapAttributes, getMapBigDecimal, getMapBoolean, getMapDate, getMapDouble, getMapInteger, getMapLong, getMapMapped, getMapObject, getMapShort, getMapString, getMapString, getMapStringBuffer, getMapStringBuilder, getMapTime, getMapTimestamp, getMapVector, hashCode, setHashFields, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMapAttributes, setMapObject, setMapTime, setMapTimestamp, toStringArray

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

The class' serialization version id.

See Also:

Constant Field Values

OPTION

private static final java.lang.String OPTION

The pattern used to create the html for a select option.

See Also:

Constant Field Values

Constructor Detail

Option

public Option(java.lang.String text)

Constructs a new instance of Option using the supplied parameters. Defaults the option value to the given text and the selected state to "unselected".

Parameters:

text - (String) The text to display for the option. The supplied value is auto-encoded for html safe characters. To construct an option with text that is already html safe, set this value to an empty string and then use the setTextHS() method to set the html safe text value.

Option

public Option(java.lang.String text,
              java.lang.String value)

Constructs a new instance of Option using the supplied parameters. Defaults the option selected state to "unselected".

Parameters:

text - (String) The text to display for the option. The supplied value is auto-encoded for html safe characters. To construct an option with text that is already html safe, set this value to an empty string and then use the setTextHS() method to set the html safe text value.

value - (String) The value returned for a selected option.

Option

public Option(java.lang.String text,
              java.lang.String value,
              boolean selected)

Constructs a new instance of Option using the supplied parameters.

Parameters:

text - (String) The text to display for the option. The supplied value is auto-encoded for html safe characters. To construct an option with text that is already html safe, set this value to an empty string and then use the setTextHS() method to set the html safe text value.

value - (String) The value returned for a selected option.

selected - (boolean) true to set the initial state of the option to "selected", otherwise false.

Method Detail

equals

public boolean equals(java.lang.Object obj)

Compares the given object to this object and determines if the two are equal. Equality is based on formatted html.

Specified by:

equals in class MappedAttributesObject

Parameters:

obj - (Object) The object to compare with this object.

Returns:

boolean - true if the specified object is equal to this object, otherwise false.

getSelected

public boolean getSelected()

Returns the option's selected state attribute.

Returns:

boolean - The option's selected state.

setSelected

public void setSelected(boolean selected)

Sets the option's selected state attribute.

Parameters:

selected - (boolean) The option's selected state.

getText

public java.lang.String getText()

Returns the option's text attribute.

Returns:

String - The option's text.

setText

public void setText(java.lang.String text)

Sets the option's text attribute.

Parameters:

text - (String) The option's text. The supplied value is encoded for html safe characters.

setTextHS

public void setTextHS(java.lang.String text)

Sets the option's text attribute.

Parameters:

text - (String) The option's text. The supplied value is assumed to contain html safe characters. No additional encoding is done.

getValue

public java.lang.String getValue()

Returns the option's value attribute.

Returns:

String - The option's value.

setValue

public void setValue(java.lang.String value)

Sets the option's value attribute.

Parameters:

value - (String) The option's value.

formatAttr

private java.lang.String formatAttr(java.lang.String attr)

Returns a formatted html string for the requested attribute value.

Returns:

String - A formatted html string.

toHTML

public java.lang.String toHTML()

Returns a formatted html string for the option's current attribute values.

Returns:

String - A formatted html string.