com.groiss.gui.component

Class SelectList

java.lang.Object

com.groiss.gui.AbstractComponent

com.groiss.gui.component.SelectList

All Implemented Interfaces:

Component, Serializable, Cloneable

Direct Known Subclasses:

DropdownList

public class SelectList
extends AbstractComponent

A HTML select list with size > 1.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	MULTIPLE
static String	OPTION
static String	SELECT
static String	SELECTED
static String	SELECTLIST
static String	SIZE
static String	VALUE

Fields inherited from class com.groiss.gui.AbstractComponent

ACTIVE, browserMode, DEFAULT, ID, IE, INVISIBLE, isSensitive, label, NS, ON_BLUR, ON_CHANGE, ON_CLICK, ON_DBLCLICK, ON_FOCUS, ON_KEY_DOWN, ON_KEY_PRESS, ON_KEY_UP, ON_LOAD, ON_MOUSE_DOWN, ON_MOUSE_MOVE, ON_MOUSE_OUT, ON_MOUSE_UP, ON_RESET, ON_SELECT, ON_SUBMIT, ON_UNLOAD, parent, parentElem, READONLY, root, viewMode

Fields inherited from interface com.groiss.gui.Component

LABELLEDBY

Constructor Summary

Constructors

Constructor and Description
SelectList() Constructs a new empty dropdown list component.
SelectList(String name, Collection<?> list, int size) Constructor with name and content list.
SelectList(String name, Collection<?> list, int size, boolean showNull) Constructor with name and content list.
SelectList(String name, Collection<?> list, int size, boolean showNull, String selected) Constructor with name and content list.
SelectList(String name, Collection<?> list, int size, boolean showNull, String selected, String styleClass) Constructor with name and content list.
SelectList(String name, int size) Constructor with name.

Method Summary

Modifier and Type	Method and Description
void	addOption(Element option) adds a new option at the end to the dropdownlist
void	addOption(int i, Element option) adds a new option at the passed position within the dropdownlist
void	addOption(int i, String value, String text)
void	addOption(KeyValuePair<?,?> p) Adds a new option at the end to the dropdownlist
void	addOption(String value, String text) adds a new option at the end to the dropdownlist
Element	addOption(String value, String text, Element rt)
void	addOptions(Collection<? extends KeyValuePair<?,?>> options) Adds all options at the end of the dropdownlist
void	clear() removes all options from this selectlist
void	deleteOption(int index) Removes the specified option, if it can be identified, from the dropdownlist.
void	deleteOption(String value) Removes the specified option, if it can be identified, from the dropdownlist.
void	deleteOption(String value, String text) Deprecated. use method with one argument
Object	getContent() Get the list of options.
Element	getOption(int index)
int	getOptionIndex(String value, String text) returns the index of the specified option (identified by value-text-pair
String	getOptionText(int index) Returns the displayed text of the specified option.
List<String>	getOptionTexts() Returns a vector with the displayed text of every option.
String	getOptionValue(int index) Returns the value of the specified option.
List<String>	getOptionValues() Returns a vector with the value of every options.
int	getSelectedOption() Returns the index of the selected option.
int[]	getSelections() returns a array of all selected options
int	getSize() returns the number of nested options in the dropdownlist - the size
boolean	isSelected(int index) Returns whether the specified option has the attribute SELECTED, or not
void	removeSelection() Removes the attribute SELECTED from the selected option.
void	removeSelections() removes the attribute SELECTED from the selected options
void	setContent(Object o) Sets the list of options.
void	setContent(Object o, boolean showNull) Sets the list of options.
void	setContent(Object o, KeyValuePair<?,?> val) Sets the list of options.
void	setDisplayedSize(int size) sets the displayed list size
void	setMultiple(boolean yesno)
void	setSelectedOption(int index) Adds the attribute SELECTED to the specified option.
void	setSelectedOption(String value) Adds the attribute SELECTED to the specified option.
void	setSelectedOptions(List<String> vals)
String	showOptions() Show the options text.

Methods inherited from class com.groiss.gui.AbstractComponent

addClass, clone, create, getAttribute, getBrowserMode, getId, getLabel, getName, getParent, getParentElement, getRoot, getRootName, getStyle, getViewMode, init, init, init, removeAttribute, removeClass, setActionListener, setAttribute, setBrowserMode, setClass, setEncoding, setExpandEmptyElements, setId, setIndenting, setLabel, setName, setNewLines, setParent, setParentElement, setRootName, setStyle, setViewMode, show, show, toggleClass, toString

Methods inherited from class java.lang.Object

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

Field Detail

OPTION

public static final String OPTION

See Also:

Constant Field Values

VALUE

public static final String VALUE

See Also:

Constant Field Values

SELECT

public static final String SELECT

See Also:

Constant Field Values

SIZE

public static final String SIZE

See Also:

Constant Field Values

MULTIPLE

public static final String MULTIPLE

See Also:

Constant Field Values

SELECTED

public static final String SELECTED

See Also:

Constant Field Values

SELECTLIST

public static final String SELECTLIST

See Also:

Constant Field Values

Constructor Detail

SelectList

public SelectList()

Constructs a new empty dropdown list component.

SelectList

public SelectList(String name,
                  int size)

Constructor with name.

Parameters:

name - the name of the form element

SelectList

public SelectList(String name,
                  Collection<?> list,
                  int size)

Constructor with name and content list.

Parameters:

name - the name of the form element

list - the content list

size - the number of visible lines

SelectList

public SelectList(String name,
                  Collection<?> list,
                  int size,
                  boolean showNull)

Constructor with name and content list.

Parameters:

name - the name of the form element

list - the content list

size - the number of visible lines

showNull - if true, add the option with value and display string empty to the begin of the list

SelectList

public SelectList(String name,
                  Collection<?> list,
                  int size,
                  boolean showNull,
                  String selected)

Constructor with name and content list.

Parameters:

name - the name of the form element

list - the content list

size - the number of visible lines

showNull - if true, add the option with value and display string empty to the begin of the list

selected - the option where the value equals this argument is selected

SelectList

public SelectList(String name,
                  Collection<?> list,
                  int size,
                  boolean showNull,
                  String selected,
                  String styleClass)

Constructor with name and content list.

Parameters:

name - the name of the form element

list - the content list

size - the number of visible lines

showNull - if true, add the option with value and display string empty to the begin of the list

selected - the option where the value equals this argument is selected

styleClass - the name of a CSS class

Method Detail

setMultiple

public void setMultiple(boolean yesno)

addOption

public void addOption(String value,
                      String text)

adds a new option at the end to the dropdownlist

Parameters:

value - the value of the new option

text - the displayed text of the new option

addOption

public Element addOption(String value,
                         String text,
                         Element rt)

addOption

public void addOption(int i,
                      String value,
                      String text)

addOption

public void addOption(Element option)

adds a new option at the end to the dropdownlist

Parameters:

option - an Element describing the option to add

addOption

public void addOption(int i,
                      Element option)

adds a new option at the passed position within the dropdownlist

Parameters:

i - the index where to add the option

option - an Element describing the option to add

addOption

public void addOption(KeyValuePair<?,?> p)

Adds a new option at the end to the dropdownlist

Parameters:

p - the new option

addOptions

public void addOptions(Collection<? extends KeyValuePair<?,?>> options)

Adds all options at the end of the dropdownlist

Parameters:

options - the options

deleteOption

@Deprecated
public void deleteOption(String value,
                                     String text)

Deprecated. use method with one argument

Removes the specified option, if it can be identified, from the dropdownlist.

Parameters:

value - the value of the specified option

text - the displayed text of the new option

deleteOption

public void deleteOption(String value)

Removes the specified option, if it can be identified, from the dropdownlist.

Parameters:

value - the value of the specified option

deleteOption

public void deleteOption(int index)

Removes the specified option, if it can be identified, from the dropdownlist.

Parameters:

index - the position of the specified option in the dropdownlist

getOptionText

public String getOptionText(int index)

Returns the displayed text of the specified option.

Parameters:

index - the position of the specified option in the dropdownlist

Returns:

the displayed text

getOption

public Element getOption(int index)

getOptionValue

public String getOptionValue(int index)

Returns the value of the specified option.

Parameters:

index - the position of the specified option in the dropdownlist

Returns:

the value

getSelectedOption

public int getSelectedOption()

Returns the index of the selected option.

Returns:

the index; if no option is selected "-1"

setSelectedOption

public void setSelectedOption(int index)

Adds the attribute SELECTED to the specified option.

Parameters:

index - the option which is selected

setSelectedOption

public void setSelectedOption(String value)

Adds the attribute SELECTED to the specified option.

Parameters:

value - the option value which is selected

removeSelection

public void removeSelection()

Removes the attribute SELECTED from the selected option.

isSelected

public boolean isSelected(int index)

Returns whether the specified option has the attribute SELECTED, or not

Parameters:

index - the index of the specified option

Returns:

true if the option is selected

getOptionValues

public List<String> getOptionValues()

Returns a vector with the value of every options.

Returns:

the Vector

getOptionTexts

public List<String> getOptionTexts()

Returns a vector with the displayed text of every option.

Returns:

the Vector

getSize

public int getSize()

returns the number of nested options in the dropdownlist - the size

Returns:

the size

setContent

public void setContent(Object o)

Sets the list of options.

Specified by:

setContent in interface Component

Overrides:

setContent in class AbstractComponent

Parameters:

o - must be a collection

setContent

public void setContent(Object o,
                       boolean showNull)

Sets the list of options.

Parameters:

o - a collection of objects for the options

showNull - if true, add the option with value and display string empty to the begin of the list

setContent

public void setContent(Object o,
                       KeyValuePair<?,?> val)

Sets the list of options.

Parameters:

o - a collection of objects for the options

val - a pair where the key equals one of the keys of the content parameter

getContent

public Object getContent()

Get the list of options.

Specified by:

getContent in interface Component

Overrides:

getContent in class AbstractComponent

Returns:

a list of pairs of value and text strings

showOptions

public String showOptions()

Show the options text.

Returns:

the content object of the component

setSelectedOptions

public void setSelectedOptions(List<String> vals)

getSelections

public int[] getSelections()

returns a array of all selected options

Returns:

the indeces of the selected options

removeSelections

public void removeSelections()

removes the attribute SELECTED from the selected options

setDisplayedSize

public void setDisplayedSize(int size)

sets the displayed list size

Parameters:

size - the size

getOptionIndex

public int getOptionIndex(String value,
                          String text)

returns the index of the specified option (identified by value-text-pair

Parameters:

value - the value of the specified option

text - the displayed text of the specified option

Returns:

the index of the specified option

clear

public void clear()

removes all options from this selectlist