com.dpslink.base.html

Class Select

java.lang.Object

com.dpslink.base.obj.MappedAttributesObject

com.dpslink.base.html.AbstractField

com.dpslink.base.html.Select

All Implemented Interfaces:

java.io.Serializable

public class Select
extends AbstractField

Defines an HTML select form field.

See Also:

Serialized Form

Field Summary

Fields

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

Fields inherited from class com.dpslink.base.html.AbstractField

PARAM

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

ivHashCode, ivHashFlds, ivObjAttrs

Constructor Summary

Constructors

Constructor and Description
Select(java.lang.String name) Constructs a new instance of Select using the supplied parameters.
Select(java.lang.String name, int size) Constructs a new instance of Select using the supplied parameters.
Select(java.lang.String name, int size, boolean multiple) Constructs a new instance of Select using the supplied parameters.

Method Summary

Modifier and Type	Method and Description
void	addOption(Option option) Adds an option to the end of the select's set of options.
void	deselectAllOptions() Deselects all options within the select's set of options.
boolean	equals(java.lang.Object obj) Compares the given object to this object and determines if the two are equal.
protected java.lang.String	formatAttr(java.lang.String attr) Returns a formatted html string for the requested attribute value.
boolean	getMultiple() Returns the select's multiselect state attribute.
java.lang.String	getOnChange() Returns the select's onchange event handler attribute.
int	getSelectedIndex() Returns the index of the selected option within the select's set of options.
int[]	getSelectedIndexes() Returns the indexes for all selected options within the select's set of options.
java.lang.String	getSelectedValue() Returns the value of the selected option within the select's set of options.
java.lang.String[]	getSelectedValues() Returns the values for all selected options within the select's set of options.
int	getSize() Returns the select's size attribute.
boolean	hasOptions() Answers if this select object has any options.
void	insertBlankOption() Inserts a blank (empty) option as the first option, if the first option is not already a blank option.
void	insertOptionAt(Option option, int index) Inserts an option at the specified index within the select's set of options.
java.util.ArrayList<Option>	options() Returns the select's set of options.
java.lang.String	optionsToHTML() Returns a formatted html string for the select's set of options.
void	removeAllOptions() Removes all options within the select's set of options.
void	removeOptionAt(int index) Removes the option at the specified index within the select's set of options.
void	selectAllOptions() Selects all options within the select's set of options.
void	setMultiple(boolean multiple) Sets the select's multiselect state attribute.
void	setOnChange(java.lang.String onchange) Sets the select's onchange event handler attribute.
void	setSelectedIndex(int index) Selects the option at the specified index within the select's set of options.
void	setSelectedValue(java.lang.String value) Selects the option with the specified value within the select's set of options.
void	setSize(int size) Sets the select's size attribute.
void	sort() Sorts the select's current set of options according to each option's text attribute.
java.lang.String	toHTML() Returns a formatted html string for the select's current attribute values and set of options.

Methods inherited from class com.dpslink.base.html.AbstractField

getDisabled, getId, getName, getOnBlur, getOnClick, getOnDblClick, getOnFocus, getOnKeyDown, getOnKeyPress, getOnKeyUp, getOnMouseOut, getOnMouseOver, getStyleCls, getStyleStr, setDisabled, setId, setName, setOnBlur, setOnClick, setOnDblClick, setOnFocus, setOnKeyDown, setOnKeyPress, setOnKeyUp, setOnMouseOut, setOnMouseOver, setStyleCls, setStyleStr

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

SELECT

private static final java.lang.String SELECT

The pattern used to create the html for a select form field.

See Also:

Constant Field Values

Constructor Detail

Select

public Select(java.lang.String name)

Constructs a new instance of Select using the supplied parameters. Defaults the select size to "1" and the multiselect state to "single".

Parameters:

name - (String) The form field name for the select.

Select

public Select(java.lang.String name,
              int size)

Constructs a new instance of Select using the supplied parameters. Defaults the select multiselect state to "single".

Parameters:

name - (String) The form field name for the select.

size - (int) The number of visible options for the select.

Select

public Select(java.lang.String name,
              int size,
              boolean multiple)

Constructs a new instance of Select using the supplied parameters.

Parameters:

name - (String) The form field name for the select.

size - (int) The number of visible options for the select.

multiple - (boolean) true to set the multiselect state of the select to "multiple", 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.

formatAttr

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

Returns a formatted html string for the requested attribute value. Overrides formatAttr in AbstractField.

Overrides:

formatAttr in class AbstractField

Returns:

String - A formatted html string.

See Also:

AbstractField.formatAttr(java.lang.String)

toHTML

public java.lang.String toHTML()

Returns a formatted html string for the select's current attribute values and set of options. Overrides toHTML in AbstractField.

Overrides:

toHTML in class AbstractField

Returns:

String - A formatted html string.

See Also:

AbstractField.toHTML()

getMultiple

public boolean getMultiple()

Returns the select's multiselect state attribute.

Returns:

boolean - The select's multiselect state.

setMultiple

public void setMultiple(boolean multiple)

Sets the select's multiselect state attribute.

Parameters:

multiple - (boolean) The select's multiselect state.

getOnChange

public java.lang.String getOnChange()

Returns the select's onchange event handler attribute.

Returns:

String - The select's onchange event handler.

setOnChange

public void setOnChange(java.lang.String onchange)

Sets the select's onchange event handler attribute.

Parameters:

onchange - (String) The select's onchange event handler.

getSize

public int getSize()

Returns the select's size attribute.

Returns:

int - The select's size.

setSize

public void setSize(int size)

Sets the select's size attribute.

Parameters:

size - (int) The select's size.

addOption

public void addOption(Option option)

Adds an option to the end of the select's set of options.

Parameters:

option - (Option) The option to add.

deselectAllOptions

public void deselectAllOptions()

Deselects all options within the select's set of options.

getSelectedIndex

public int getSelectedIndex()

Returns the index of the selected option within the select's set of options. If this select is multiselect, only the index for the first selected option is returned.

Returns:

int - The index of the selected option or negative one (-1) if there are no selected options.

getSelectedIndexes

public int[] getSelectedIndexes()

Returns the indexes for all selected options within the select's set of options.

Returns:

int[] - An array of selected indexes or null if no options are selected.

getSelectedValue

public java.lang.String getSelectedValue()

Returns the value of the selected option within the select's set of options. If this select is multiselect, only the value for the first selected option is returned.

Returns:

String - The value of the selected option or null if there are no selected options.

getSelectedValues

public java.lang.String[] getSelectedValues()

Returns the values for all selected options within the select's set of options.

Returns:

String[] - An array of selected values or null if no options are selected.

hasOptions

public boolean hasOptions()

Answers if this select object has any options.

Returns:

boolean - true if the select has options, otherwise false.

insertBlankOption

public void insertBlankOption()

Inserts a blank (empty) option as the first option, if the first option is not already a blank option.

insertOptionAt

public void insertOptionAt(Option option,
                           int index)

Inserts an option at the specified index within the select's set of options. If the specified index is out of range, the option is added to the end of the set of options.

Parameters:

option - (Option) The option to insert.

index - (int) The index where the option is to be inserted.

options

public java.util.ArrayList<Option> options()

Returns the select's set of options.

Returns:

ArrayList - The select's options.

optionsToHTML

public java.lang.String optionsToHTML()

Returns a formatted html string for the select's set of options.

Returns:

String - A formatted html string.

removeOptionAt

public void removeOptionAt(int index)

Removes the option at the specified index within the select's set of options. Silently fails if the specified index is out of range.

Parameters:

index - (int) The index for the option to be removed.

removeAllOptions

public void removeAllOptions()

Removes all options within the select's set of options.

selectAllOptions

public void selectAllOptions()

Selects all options within the select's set of options. If this select is not multiselect, only the first option is selected.

setSelectedIndex

public void setSelectedIndex(int index)

Selects the option at the specified index within the select's set of options. If this select is not multiselect, all other options are deselected. Silently fails if the specified index is out of range.

Parameters:

index - (int) The index for the option to be selected.

setSelectedValue

public void setSelectedValue(java.lang.String value)

Selects the option with the specified value within the select's set of options. If this select is not multiselect, all other options are deselected. If more than one option exists with the specified value, the first option found is selected.

Parameters:

value - (String) The value for the option to be selected.

sort

public void sort()

Sorts the select's current set of options according to each option's text attribute.