Package com.helger.html.hc.html.forms

Class AbstractHCSelect<IMPLTYPE extends AbstractHCSelect<IMPLTYPE>>

java.lang.Object

com.helger.html.hc.impl.AbstractHCNode

com.helger.html.hc.html.AbstractHCElement<IMPLTYPE>

com.helger.html.hc.html.forms.AbstractHCControl<IMPLTYPE>

com.helger.html.hc.html.forms.AbstractHCSelect<IMPLTYPE>

Type Parameters:

IMPLTYPE - the implementation type

All Implemented Interfaces:

com.helger.commons.hierarchy.IHasChildren<IHCNode>, com.helger.commons.hierarchy.IHasChildrenRecursive<IHCNode>, com.helger.commons.hierarchy.IHasChildrenSorted<IHCNode>, com.helger.commons.traits.IGenericImplTrait<IMPLTYPE>, IHCControl<IMPLTYPE>, IHCHasFocus<IMPLTYPE>, IHCSelect<IMPLTYPE>, IHCElement<IMPLTYPE>, IHCHasCSSClasses<IMPLTYPE>, IHCHasCSSStyles<IMPLTYPE>, IHCHasState<IMPLTYPE>, IHCHasID<IMPLTYPE>, IHCHasName<IMPLTYPE>, IHCNode, Serializable

Direct Known Subclasses:

HCSelect

public abstract class AbstractHCSelect<IMPLTYPE extends AbstractHCSelect<IMPLTYPE>>
extends AbstractHCControl<IMPLTYPE>
implements IHCSelect<IMPLTYPE>

Represents an HTML <select> element

Author:

Philip Helger

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static boolean	DEFAULT_MULTIPLE	By default multi select is disabled

Fields inherited from class com.helger.html.hc.html.forms.AbstractHCControl

CSS_CLASS_READ_ONLY, DEFAULT_AUTO_FOCUS, DEFAULT_DISABLED, DEFAULT_READ_ONLY, DEFAULT_REQUIRED

Fields inherited from class com.helger.html.hc.html.AbstractHCElement

DEFAULT_HIDDEN, DEFAULT_SPELLCHECK, DEFAULT_TRANSLATE, DEFAULT_UNFOCUSABLE

Fields inherited from interface com.helger.html.hc.html.IHCElement

DEFAULT_TABINDEX

Constructor Summary

Constructors

Constructor	Description
AbstractHCSelect()
AbstractHCSelect(IHCRequestField aRF)
AbstractHCSelect(IHCRequestFieldMultiValue aRF)

Method Summary

Modifier and Type	Method	Description
HCOption	addOption(HCOption aOption)
HCOption	addOptionAt(int nIndex, HCOption aOption)	Add a new option at the specified index.
IMPLTYPE	addOptionGroup(HCOptGroup aOptGroup)
com.helger.commons.collection.impl.ICommonsList<IHCNode>	children()
protected void	fillMicroElement(com.helger.xml.microdom.IMicroElement aElement, IHCConversionSettingsToNode aConversionSettings)	Set all attributes and child elements of this object
com.helger.commons.collection.impl.ICommonsList<IHCNode>	getAllChildren()
com.helger.commons.collection.impl.ICommonsList<HCOptGroup>	getAllOptionGroups()
com.helger.commons.collection.impl.ICommonsList<HCOption>	getAllOptions()
com.helger.commons.collection.impl.ICommonsSet<String>	getAllPreselectedValues()
com.helger.commons.collection.impl.ICommonsList<HCOption>	getAllSelectedOptions()
IHCNode	getChildAtIndex(int nIndex)
int	getChildCount()
com.helger.commons.collection.impl.ICommonsIterable<IHCNode>	getChildren()
IHCNode	getFirstChild()
HCOption	getFirstSelectedOption()
String	getForm()
IHCNode	getLastChild()
HCOption	getOptionAtIndex(int nIndex)	Get the option at the specified index
int	getOptionCount()
HCOptGroup	getOptionGroupAtIndex(int nIndex)	Get the option group at the specified index
int	getOptionGroupCount()
int	getSelectedOptionCount()
int	getSize()
boolean	hasChildren()
boolean	hasOptionGroups()
boolean	hasOptions()
boolean	hasSelectedOption()	Check if this select has at least one selected option
boolean	isMultiple()
boolean	isPreselectedValue(String sValue)
protected void	onAddOption(HCOption aOption)	Callback
IMPLTYPE	removeAllOptionGroups()
IMPLTYPE	removeAllOptions()
IMPLTYPE	removeOptionAt(int nIndex)	Remove the option at the specified index.
IMPLTYPE	removeOptionGroupAt(int nIndex)	Remove the option group at the specified index.
IMPLTYPE	setForm(String sForm)
IMPLTYPE	setMultiple(boolean bMultiple)
IMPLTYPE	setSize(int nSize)
String	toString()

Methods inherited from class com.helger.html.hc.html.forms.AbstractHCControl

getName, isAutoFocus, isDisabled, isReadOnly, isRequired, onFinalizeNodeState, setAutoFocus, setDisabled, setName, setReadOnly, setRequired

Methods inherited from class com.helger.html.hc.html.AbstractHCElement

addClass, addEventHandler, addStyle, containsClass, containsEventHandler, containsStyle, createMicroElement, customAttrs, finishMicroElement, getAccessKey, getAllClasses, getAllClassesAsString, getAllClassNames, getAllStyles, getAllStylesAsString, getAllStyleValues, getContentEditable, getDirection, getDraggable, getElement, getEventHandler, getEventMap, getID, getLanguage, getRole, getStyleValue, getTabIndex, getTagName, getTitle, getTranslate, hasAnyClass, hasAnyStyle, hasStyle, internalConvertToMicroNode, isHidden, isSpellCheck, isTranslateOff, isTranslateOn, isTranslateUndefined, isUnfocusable, isValidID, onConsistencyCheck, prependEventHandler, removeAllClasses, removeAllEventHandler, removeAllStyles, removeClass, removeStyle, setAccessKey, setContentEditable, setDirection, setDraggable, setEventHandler, setHidden, setID, setID, setLanguage, setRole, setSpellCheck, setTabIndex, setTitle, setTranslate, setUnfocusable

Methods inherited from class com.helger.html.hc.impl.AbstractHCNode

canConvertToMicroNode, consistencyCheck, convertToMicroNode, customizeNode, finalizeNodeState, findFirstChild, findFirstChildMapped, forAllChildren, forAllChildren, forAllChildrenBreakable, forAllChildrenMapped, getNodeState, getPlainText, internalSetNodeState, onCustomizeNode, onRegisterExternalResources, registerExternalResources

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.commons.traits.IGenericImplTrait

thisAsT

Methods inherited from interface com.helger.commons.hierarchy.IHasChildren

forAllChildren, forAllChildren, forAllChildrenBreakable, forAllChildrenMapped, hasNoChildren

Methods inherited from interface com.helger.commons.hierarchy.IHasChildrenRecursive

forAllChildrenRecursive, forAllChildrenRecursive

Methods inherited from interface com.helger.commons.hierarchy.IHasChildrenSorted

findFirstChild, findFirstChildMapped

Methods inherited from interface com.helger.html.hc.html.forms.IHCControl

isReadOnly, isRequired, setReadOnly, setRequired

Methods inherited from interface com.helger.html.hc.html.IHCElement

addEventHandler, containsEventHandler, customAttrs, getAccessKey, getContentEditable, getDirection, getDraggable, getElement, getEventHandler, getEventMap, getLanguage, getRole, getTabIndex, getTagName, getTitle, getTranslate, isHidden, isSpellCheck, isTranslateOff, isTranslateOn, isTranslateUndefined, isUnfocusable, prependEventHandler, removeAllEventHandler, setAccessKey, setContentEditable, setDirection, setDraggable, setEventHandler, setHidden, setLanguage, setRole, setSpellCheck, setTabIndex, setTitle, setTranslate, setTranslate, setUnfocusable, withCustomAttrs

Methods inherited from interface com.helger.html.hc.html.IHCHasCSSClasses

addClass, addClasses, addClasses, addClasses, containsClass, getAllClasses, getAllClassesAsString, getAllClassNames, hasAnyClass, removeAllClasses, removeClass

Methods inherited from interface com.helger.html.hc.html.IHCHasCSSStyles

addStyle, addStyle, addStyles, addStyles, addStyles, containsStyle, getAllStyles, getAllStylesAsString, getAllStyleValues, getStyleValue, hasAnyStyle, hasStyle, removeAllStyles, removeStyle

Methods inherited from interface com.helger.html.hc.IHCHasID

ensureID, getID, hasID, hasNoID, setID, setUniqueID

Methods inherited from interface com.helger.html.hc.IHCHasName

getName, setName

Methods inherited from interface com.helger.html.hc.html.IHCHasState

isDisabled, setDisabled

Methods inherited from interface com.helger.html.hc.IHCNode

canConvertToMicroNode, consistencyCheck, convertToMicroNode, customizeNode, finalizeNodeState, getNodeState, getPlainText, registerExternalResources

Methods inherited from interface com.helger.html.hc.html.forms.IHCSelect

addOption, addOption, addOption, addOption, addOption, addOptionAt, getFirstSelectedOptionValue, isAutoFocus, setAutoFocus

Field Detail

DEFAULT_MULTIPLE

public static final boolean DEFAULT_MULTIPLE

By default multi select is disabled

See Also:

Constant Field Values

Constructor Detail

AbstractHCSelect

public AbstractHCSelect()

AbstractHCSelect

public AbstractHCSelect(@Nonnull
                        IHCRequestField aRF)

AbstractHCSelect

public AbstractHCSelect(@Nonnull
                        IHCRequestFieldMultiValue aRF)

Method Detail

getForm

@Nullable
public final String getForm()

Specified by:

getForm in interface IHCSelect<IMPLTYPE extends AbstractHCSelect<IMPLTYPE>>

setForm

@Nonnull
public final IMPLTYPE setForm(@Nullable
                              String sForm)

Specified by:

setForm in interface IHCSelect<IMPLTYPE extends AbstractHCSelect<IMPLTYPE>>

isMultiple

public final boolean isMultiple()

Specified by:

isMultiple in interface IHCSelect<IMPLTYPE extends AbstractHCSelect<IMPLTYPE>>

setMultiple

@Nonnull
public final IMPLTYPE setMultiple(boolean bMultiple)

Specified by:

setMultiple in interface IHCSelect<IMPLTYPE extends AbstractHCSelect<IMPLTYPE>>

getSize

public final int getSize()

Specified by:

getSize in interface IHCSelect<IMPLTYPE extends AbstractHCSelect<IMPLTYPE>>

setSize

@Nonnull
public final IMPLTYPE setSize(int nSize)

Specified by:

setSize in interface IHCSelect<IMPLTYPE extends AbstractHCSelect<IMPLTYPE>>

getAllPreselectedValues

@Nonnull
@ReturnsMutableCopy
public final com.helger.commons.collection.impl.ICommonsSet<String> getAllPreselectedValues()

Specified by:

getAllPreselectedValues in interface IHCSelect<IMPLTYPE extends AbstractHCSelect<IMPLTYPE>>

isPreselectedValue

public final boolean isPreselectedValue(@Nullable
                                        String sValue)

Specified by:

isPreselectedValue in interface IHCSelect<IMPLTYPE extends AbstractHCSelect<IMPLTYPE>>

onAddOption

@OverrideOnDemand
protected void onAddOption(@Nonnull
                           HCOption aOption)

Callback

Parameters:

aOption - The added option. Never null.

addOption

@Nonnull
public final HCOption addOption(@Nonnull
                                HCOption aOption)

Specified by:

addOption in interface IHCSelect<IMPLTYPE extends AbstractHCSelect<IMPLTYPE>>

addOptionAt

@Nonnull
public final HCOption addOptionAt(@Nonnegative
                                  int nIndex,
                                  @Nonnull
                                  HCOption aOption)

Description copied from interface: IHCSelect

Add a new option at the specified index.

Specified by:

addOptionAt in interface IHCSelect<IMPLTYPE extends AbstractHCSelect<IMPLTYPE>>

Parameters:

nIndex - The index to use. Should be ≥ 0.

aOption - The option to be added. May not be null.

Returns:

this for chaining

addOptionGroup

@Nonnull
public final IMPLTYPE addOptionGroup(@Nullable
                                     HCOptGroup aOptGroup)

Specified by:

addOptionGroup in interface IHCSelect<IMPLTYPE extends AbstractHCSelect<IMPLTYPE>>

removeAllOptions

@Nonnull
public final IMPLTYPE removeAllOptions()

Specified by:

removeAllOptions in interface IHCSelect<IMPLTYPE extends AbstractHCSelect<IMPLTYPE>>

removeAllOptionGroups

@Nonnull
public final IMPLTYPE removeAllOptionGroups()

Specified by:

removeAllOptionGroups in interface IHCSelect<IMPLTYPE extends AbstractHCSelect<IMPLTYPE>>

removeOptionAt

@Nonnull
public final IMPLTYPE removeOptionAt(@Nonnegative
                                     int nIndex)

Description copied from interface: IHCSelect

Remove the option at the specified index.

Specified by:

removeOptionAt in interface IHCSelect<IMPLTYPE extends AbstractHCSelect<IMPLTYPE>>

Parameters:

nIndex - The index to be removed. Should be ≥ 0.

Returns:

this for chaining

removeOptionGroupAt

@Nonnull
public final IMPLTYPE removeOptionGroupAt(@Nonnegative
                                          int nIndex)

Description copied from interface: IHCSelect

Remove the option group at the specified index.

Specified by:

removeOptionGroupAt in interface IHCSelect<IMPLTYPE extends AbstractHCSelect<IMPLTYPE>>

Parameters:

nIndex - The index to be removed. Should be ≥ 0.

Returns:

this for chaining

getOptionCount

@Nonnegative
public final int getOptionCount()

Specified by:

getOptionCount in interface IHCSelect<IMPLTYPE extends AbstractHCSelect<IMPLTYPE>>

Returns:

The number of available options.

getOptionGroupCount

@Nonnegative
public final int getOptionGroupCount()

Specified by:

getOptionGroupCount in interface IHCSelect<IMPLTYPE extends AbstractHCSelect<IMPLTYPE>>

Returns:

The number of available option groups.

getAllOptions

@Nonnull
@ReturnsMutableCopy
public final com.helger.commons.collection.impl.ICommonsList<HCOption> getAllOptions()

Specified by:

getAllOptions in interface IHCSelect<IMPLTYPE extends AbstractHCSelect<IMPLTYPE>>

Returns:

A non-null list of all available options.

getAllOptionGroups

@Nonnull
@ReturnsMutableCopy
public final com.helger.commons.collection.impl.ICommonsList<HCOptGroup> getAllOptionGroups()

Specified by:

getAllOptionGroups in interface IHCSelect<IMPLTYPE extends AbstractHCSelect<IMPLTYPE>>

Returns:

A non-null list of all available option groups.

getOptionAtIndex

@Nullable
public final HCOption getOptionAtIndex(@Nonnegative
                                       int nIndex)

Description copied from interface: IHCSelect

Get the option at the specified index

Specified by:

getOptionAtIndex in interface IHCSelect<IMPLTYPE extends AbstractHCSelect<IMPLTYPE>>

Parameters:

nIndex - The index to retrieve. Should always be ≥ 0.

Returns:

null if no option is available for the specified index.

getOptionGroupAtIndex

@Nullable
public final HCOptGroup getOptionGroupAtIndex(@Nonnegative
                                              int nIndex)

Description copied from interface: IHCSelect

Get the option group at the specified index

Specified by:

getOptionGroupAtIndex in interface IHCSelect<IMPLTYPE extends AbstractHCSelect<IMPLTYPE>>

Parameters:

nIndex - The index to retrieve. Should always be ≥ 0.

Returns:

null if no option group is available for the specified index.

hasOptions

public final boolean hasOptions()

Specified by:

hasOptions in interface IHCSelect<IMPLTYPE extends AbstractHCSelect<IMPLTYPE>>

Returns:

true if this select has at least one option.

hasOptionGroups

public final boolean hasOptionGroups()

Specified by:

hasOptionGroups in interface IHCSelect<IMPLTYPE extends AbstractHCSelect<IMPLTYPE>>

Returns:

true if this select has at least one option group.

getAllSelectedOptions

@Nonnull
@ReturnsMutableCopy
public final com.helger.commons.collection.impl.ICommonsList<HCOption> getAllSelectedOptions()

Specified by:

getAllSelectedOptions in interface IHCSelect<IMPLTYPE extends AbstractHCSelect<IMPLTYPE>>

Returns:

A non-null list of all selected options.

getFirstSelectedOption

@Nullable
public HCOption getFirstSelectedOption()

Specified by:

getFirstSelectedOption in interface IHCSelect<IMPLTYPE extends AbstractHCSelect<IMPLTYPE>>

Returns:

The first selected option. May be null.

getSelectedOptionCount

@Nonnegative
public final int getSelectedOptionCount()

Specified by:

getSelectedOptionCount in interface IHCSelect<IMPLTYPE extends AbstractHCSelect<IMPLTYPE>>

Returns:

The number of selected options. Always ≥ 0.

hasSelectedOption

public final boolean hasSelectedOption()

Description copied from interface: IHCSelect

Check if this select has at least one selected option

Specified by:

hasSelectedOption in interface IHCSelect<IMPLTYPE extends AbstractHCSelect<IMPLTYPE>>

Returns:

true if at least one option is selected

children

@Nullable
@ReturnsMutableObject
public final com.helger.commons.collection.impl.ICommonsList<IHCNode> children()

getAllChildren

@Nullable
@ReturnsMutableCopy
public final com.helger.commons.collection.impl.ICommonsList<IHCNode> getAllChildren()

Specified by:

getAllChildren in interface com.helger.commons.hierarchy.IHasChildren<IMPLTYPE extends AbstractHCSelect<IMPLTYPE>>

Specified by:

getAllChildren in interface com.helger.commons.hierarchy.IHasChildrenSorted<IMPLTYPE extends AbstractHCSelect<IMPLTYPE>>

Overrides:

getAllChildren in class AbstractHCNode

getChildren

@Nonnull
@ReturnsImmutableObject
public final com.helger.commons.collection.impl.ICommonsIterable<IHCNode> getChildren()

Specified by:

getChildren in interface com.helger.commons.hierarchy.IHasChildren<IMPLTYPE extends AbstractHCSelect<IMPLTYPE>>

Overrides:

getChildren in class AbstractHCNode

getChildAtIndex

@Nullable
public final IHCNode getChildAtIndex(int nIndex)

Specified by:

getChildAtIndex in interface com.helger.commons.hierarchy.IHasChildrenSorted<IMPLTYPE extends AbstractHCSelect<IMPLTYPE>>

Overrides:

getChildAtIndex in class AbstractHCNode

getFirstChild

@Nullable
public final IHCNode getFirstChild()

Specified by:

getFirstChild in interface com.helger.commons.hierarchy.IHasChildrenSorted<IMPLTYPE extends AbstractHCSelect<IMPLTYPE>>

Overrides:

getFirstChild in class AbstractHCNode

getLastChild

@Nullable
public final IHCNode getLastChild()

Specified by:

getLastChild in interface com.helger.commons.hierarchy.IHasChildrenSorted<IMPLTYPE extends AbstractHCSelect<IMPLTYPE>>

Overrides:

getLastChild in class AbstractHCNode

hasChildren

public final boolean hasChildren()

Specified by:

hasChildren in interface com.helger.commons.hierarchy.IHasChildren<IMPLTYPE extends AbstractHCSelect<IMPLTYPE>>

Overrides:

hasChildren in class AbstractHCNode

getChildCount

public final int getChildCount()

Specified by:

getChildCount in interface com.helger.commons.hierarchy.IHasChildren<IMPLTYPE extends AbstractHCSelect<IMPLTYPE>>

Overrides:

getChildCount in class AbstractHCNode

fillMicroElement

protected void fillMicroElement(com.helger.xml.microdom.IMicroElement aElement,
                                IHCConversionSettingsToNode aConversionSettings)

Description copied from class: AbstractHCElement

Set all attributes and child elements of this object

Overrides:

fillMicroElement in class AbstractHCControl<IMPLTYPE extends AbstractHCSelect<IMPLTYPE>>

Parameters:

aElement - The current micro element to be filled. Never null.

aConversionSettings - The conversion settings to be used. Never null.

toString

public String toString()

Overrides:

toString in class AbstractHCControl<IMPLTYPE extends AbstractHCSelect<IMPLTYPE>>