to.etc.domui.dom.html

Class Select

java.lang.Object

to.etc.domui.dom.css.CssBase

to.etc.domui.dom.html.NodeBase

to.etc.domui.dom.html.NodeContainer

to.etc.domui.dom.html.InputNodeContainer

to.etc.domui.dom.html.Select

All Implemented Interfaces:

Iterable<NodeBase>, INodeErrorDelegate, IHasChangeListener, IHasModifiedIndication, IHtmlInput, INativeChangeListener

Direct Known Subclasses:

ComboComponentBase

public class Select
extends InputNodeContainer
implements INativeChangeListener, IHasModifiedIndication, IHtmlInput

INCOMPLETE A full-coded select box: this is unsuitable for large amount of options. Handling the selected item is incomplete.

Author:

Frits Jalvingh Created on Jul 11, 2008

Constructor Summary

Constructors

Constructor and Description
Select()
Select(String... txt)

Method Summary

Modifier and Type	Method and Description
boolean	acceptRequestParameter(String[] values)
void	addExtraButton(String img, String title, IClicked<NodeBase> click) Add a small image button after the combo.
protected void	canContain(NodeBase node) Only allow SelectOption as child.
void	clearSelected() Deprecated.
void	componentHandleWebAction(RequestContextImpl ctx, String action) Handle the action sent by the return pressed Javascript thingerydoo.
SelectOption	getOption(int ix)
IReturnPressed<Select>	getReturnPressed() Set or clear return press handler.
int	getSelectedIndex()
int	getSize()
protected boolean	internalOnUserInput(int oldindex, int nindex) Called when user input has changed the selected index.
void	internalSetSelectedIndex(int ix) Fast way to set index without walking the option tree, to use if the subclass knows a faster way to set all option selected values.
boolean	isDisabled()
boolean	isModified() Returns the modified-by-user flag.
boolean	isMultiple()
void	onAddedToPage(Page p)
void	onRemoveFromPage(Page p)
void	setDisabled(boolean disabled)
void	setDisabled(UIMessage rsn) Util for updating select enabled / disabled state depending on existence of error (reason for disabling).
void	setModified(boolean as) Set or clear the modified by user flag.
void	setMultiple(boolean multiple)
void	setReadOnly(boolean readOnly) WARNING: The "select" node HAS NO READONLY!!!
void	setReturnPressed(IReturnPressed<Select> returnPressed)
void	setSelectedIndex(int ix) Set the selected index - expensive because it has to walk all Option children and reset their selected attribute - O(n) runtime.
void	setSize(int size)
void	visit(INodeVisitor v) This must visit the appropriate method in the node visitor.

Methods inherited from class to.etc.domui.dom.html.InputNodeContainer

callOnValueChanged, getOnValueChanged, immediate, immediate, isImmediate, isMandatory, isReadOnly, setMandatory, setOnValueChanged

Methods inherited from class to.etc.domui.dom.html.NodeContainer

add, add, add, addTable, addTableForLayout, addTableForLayout, appendTreeErrors, createFrame, delegateTo, disableAllChildControlsDeep, findChildIndex, forceRebuild, getChild, getChildCount, getChildren, getDeepChildren, getDelegate, getErrorFence, getTextContents, hasError, internalAdd, internalCheckNotDirty, internalClearDelta, internalClearDeltaFully, internalCreateFrame, internalGetNodeCount, internalGetOldChildren, internalOnBeforeRender, internalShelve, internalUnshelve, iterator, onRefresh, removeAllChildren, removeChild, removeChild, replaceChild, setErrorFence, setErrorFence, setText, setValue, undelegatedAdd, undelegatedGetChild

Methods inherited from class to.etc.domui.dom.html.NodeBase

$, addBinding, addCssClass, addGlobalMessage, addNotificationListener, afterCreateContent, alignToLeft, alignToLeft, alignToMiddle, alignToMiddle, alignTopToBottom, alignTopToBottom, alignToRight, alignToRight, alignToTop, alignToTop, appendAfterMe, appendBeforeMe, appendCreateJS, appendJavascript, appendJQuerySelector, appendJsCustomUpdatesContributor, appendShowOverflowTextAsTitleJs, appendStatement, beforeCreateContent, bind, bind, bindErrors, build, calcTestID, changed, changedJavascriptState, clearFocusRequested, clearGlobalMessage, clearGlobalMessage, clearGlobalMessage, clearMessage, clearValidationFailure, componentHandleWebDataRequest, createContent, createStatement, findComponentBundle, findParent, getActualID, getAllocationTracepoint, getBindingErrors, getBindingList, getBrowserWindowSize, getCalculatedTestID, getClicked, getClientBounds, getComponentBundle, getComponentDataURL, getComponentDataURL, getComponentInfo, getComponentJSONURL, getCreateJS, getCssClass, getErrorList, getErrorLocation, getFocusID, getMessage, getOnClickJS, getOnMouseDownJS, getOnSizeAndPositionChange, getPage, getParent, getParent, getParent, getParentOfTypes, getSharedContext, getSharedContextFactory, getSpecialAttribute, getSpecialAttributeList, getTag, getTestID, getTestRepeatId, getThemedResourceRURL, getTitle, getUserObject, handleDrop, hasCssClass, hasParent, internalGetOldParent, internalGetParent, internalHasChangedAttributes, internalNeedClickHandler, internalOnClicked, internalOnValueChanged, internalRenderJavascriptDelta, internalRenderJavascriptState, internalSetHasChangedAttributes, internalSetHasChangedAttributes, internalSetLogAllocations, internalSetTag, isAttached, isBuilt, isFocusable, isFocusRequested, isRendersOwnClose, isStretchHeight, lc, notify, notifyParentOrOpenerPage, onBeforeFullRender, onBeforeRender, onForceRebuild, onHeaderContributors, onShelve, onUnshelve, refresh, remove, removeBinding, removeCssClass, renderJavascriptDelta, renderJavascriptState, renderJavascriptState, replaceWith, setBrowserWindowSize, setCalculcatedId, setCalculcatedId, setClicked, setClientBounds, setComponentBundle, setCssClass, setErrorLocation, setFocus, setMessage, setOnClickJS, setOnMouseDownJS, setOnSizeAndPositionChange, setOverrideTitle, setSpecialAttribute, setStretchHeight, setTestID, setTestRepeatID, setTitle, setUserObject, toString

Methods inherited from class to.etc.domui.dom.css.CssBase

getBackgroundAttachment, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorderBottomColor, getBorderBottomStyle, getBorderBottomWidth, getBorderLeftColor, getBorderLeftStyle, getBorderLeftWidth, getBorderRightColor, getBorderRightStyle, getBorderRightWidth, getBorderTopColor, getBorderTopStyle, getBorderTopWidth, getBottom, getCachedStyle, getClear, getColor, getDisplay, getFloat, getFontFamily, getFontSize, getFontSizeAdjust, getFontStyle, getFontVariant, getFontWeight, getHeight, getLeft, getLineHeight, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOverflow, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getPosition, getRight, getTextAlign, getTop, getTransform, getVerticalAlign, getVisibility, getWidth, getZIndex, internalSetDisplay, setBackgroundAttachment, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBorder, setBorderBottomColor, setBorderBottomStyle, setBorderBottomWidth, setBorderColor, setBorderLeftColor, setBorderLeftStyle, setBorderLeftWidth, setBorderRightColor, setBorderRightStyle, setBorderRightWidth, setBorderStyle, setBorderTopColor, setBorderTopStyle, setBorderTopWidth, setBorderWidth, setBottom, setBottom, setCachedStyle, setClear, setColor, setDisplay, setFloat, setFontFamily, setFontSize, setFontSizeAdjust, setFontStyle, setFontVariant, setFontWeight, setHeight, setLeft, setLeft, setLineHeight, setMargin, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setOverflow, setPadding, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddingTop, setPosition, setRight, setRight, setTextAlign, setTop, setTop, setTransform, setVerticalAlign, setVisibility, setWidth, setZIndex

Methods inherited from class java.lang.Object

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

Methods inherited from interface to.etc.domui.dom.html.INativeChangeListener

getOnValueChanged

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

Select

public Select()

Select

public Select(String... txt)

Method Detail

visit

public void visit(INodeVisitor v)
           throws Exception

Description copied from class: NodeBase

This must visit the appropriate method in the node visitor. It should NOT recurse it's children.

Specified by:

visit in class InputNodeContainer

Throws:

Exception

canContain

protected void canContain(@Nonnull
                          NodeBase node)

Only allow SelectOption as child.

Overrides:

canContain in class NodeContainer

See Also:

NodeContainer.canContain(to.etc.domui.dom.html.NodeBase)

isMultiple

public boolean isMultiple()

setMultiple

public void setMultiple(boolean multiple)

isDisabled

public boolean isDisabled()

Specified by:

isDisabled in interface IHtmlInput

setDisabled

public void setDisabled(boolean disabled)

Specified by:

setDisabled in interface IHtmlInput

setDisabled

public void setDisabled(@Nullable
                        UIMessage rsn)

Util for updating select enabled / disabled state depending on existence of error (reason for disabling).

Parameters:

rsn - reason to disable select. If null, select gets enabled, otherwise it gets disabled with rsn.getMessage() as title (hint)

getSize

public int getSize()

setSize

public void setSize(int size)

setReadOnly

public void setReadOnly(boolean readOnly)

WARNING: The "select" node HAS NO READONLY!!!

Overrides:

setReadOnly in class InputNodeContainer

See Also:

InputNodeContainer.setReadOnly(boolean)

getOption

public SelectOption getOption(int ix)

acceptRequestParameter

public final boolean acceptRequestParameter(@Nonnull
                                            String[] values)
                                     throws Exception

Overrides:

acceptRequestParameter in class NodeBase

Throws:

Exception

internalOnUserInput

protected boolean internalOnUserInput(int oldindex,
                                      int nindex)

Called when user input has changed the selected index.

Parameters:

oldindex -

nindex -

clearSelected

@Deprecated
public void clearSelected()

Deprecated.

Dangerous interface for derived classes.

getSelectedIndex

public int getSelectedIndex()

internalSetSelectedIndex

public void internalSetSelectedIndex(int ix)

Fast way to set index without walking the option tree, to use if the subclass knows a faster way to set all option selected values.

Parameters:

ix -

setSelectedIndex

public void setSelectedIndex(int ix)

Set the selected index - expensive because it has to walk all Option children and reset their selected attribute - O(n) runtime.

Parameters:

ix -

addExtraButton

public void addExtraButton(String img,
                           String title,
                           IClicked<NodeBase> click)

Add a small image button after the combo.

Parameters:

img -

title -

click -

onAddedToPage

public void onAddedToPage(Page p)

Overrides:

onAddedToPage in class NodeBase

onRemoveFromPage

public void onRemoveFromPage(Page p)

Overrides:

onRemoveFromPage in class NodeBase

isModified

public final boolean isModified()

Returns the modified-by-user flag.

Specified by:

isModified in interface IHasModifiedIndication

See Also:

IHasModifiedIndication.isModified()

setModified

public final void setModified(boolean as)

Set or clear the modified by user flag.

Specified by:

setModified in interface IHasModifiedIndication

See Also:

IHasModifiedIndication.setModified(boolean)

getReturnPressed

public IReturnPressed<Select> getReturnPressed()

Set or clear return press handler. Dropdown list that has size > 1 behaves different then ordinary drop down list, since value changed event gets triggered while list is browsed. In order to prevent server roundtrip for each selection change while moving trought list wth arrow keys, implement setClicked and setReturnPressed events instead.

Returns:

setReturnPressed

public void setReturnPressed(IReturnPressed<Select> returnPressed)

componentHandleWebAction

public void componentHandleWebAction(@Nonnull
                                     RequestContextImpl ctx,
                                     @Nonnull
                                     String action)
                              throws Exception

Handle the action sent by the return pressed Javascript thingerydoo.

Overrides:

componentHandleWebAction in class NodeBase

Throws:

Exception

See Also:

NodeBase.componentHandleWebAction(to.etc.domui.server.RequestContextImpl, java.lang.String)