to.etc.domui.component.input

Class DropDownPicker<T>

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.Button

to.etc.domui.component.buttons.SmallImgButton

to.etc.domui.component.input.DropDownPicker<T>

All Implemented Interfaces:

Iterable<NodeBase>, INodeErrorDelegate, IActionControl, IControl<T>, IHasChangeListener

public class DropDownPicker<T>
extends SmallImgButton
implements IControl<T>

Control that behaves as SmallImgButton that has built in click handler that popups select list with predefined data to choose from.

Author:

Vladimir Mijic Created on Nov 26, 2012

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DropDownPicker.HAlign

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_COMBO_SIZE

Constructor Summary

Constructors

Constructor and Description
DropDownPicker() DropDownPicker constructor.
DropDownPicker(List<T> data) DropDownPicker constructor.
DropDownPicker(List<T> data, int size) DropDownPicker constructor.

Method Summary

Modifier and Type	Method and Description
void	createContent()
NodeBase	getAlignmentBase() see m_alignmentBase
DropDownPicker.HAlign	getHalign() Horizontal alignment of dropdown popup.
int	getOffsetX() Returns custom offset x relative to picker btn.
int	getOffsetY() Returns custom offset y relative to getAlignmentBase() control.
INotifyEvent<DropDownPicker<T>,ComboLookup<T>>	getOnBeforeShow()
IValueChanged<DropDownPicker<T>>	getOnValueChanged()
Select	getSelectControl()
int	getSize() Returns size of drop down list.
T	getValue() Returns the current value of this input component.
T	getValueSafe() Like IControl.getValue() this returns the value of the component, but this returns null if the value was invalid.
boolean	hasData()
boolean	isMandatory() Returns T if this control is a mandatory input.
boolean	isReadOnly() Returns T if the control is currently in readonly mode.
void	setAlignmentBase(NodeBase halignmentBase) see m_alignmentBase
void	setData(List<T> data)
void	setHalign(DropDownPicker.HAlign halign) Sets picker select list horizontal alignment.
void	setMandatory(boolean mandatory) Make the control mandatory.
void	setOffsetX(int offsetX) Specify custom offset x relative to picker btn.
void	setOffsetY(int offsetY) Specify custom offset y relative to picker btn.
void	setOnBeforeShow(INotifyEvent<DropDownPicker<T>,ComboLookup<T>> onBeforeShow)
void	setOnValueChanged(IValueChanged<?> onValueChanged)
void	setReadOnly(boolean ro) Sets the input to readonly-mode.
void	setSize(int size)
void	setValue(T value) Set a new value into this control.

Methods inherited from class to.etc.domui.component.buttons.SmallImgButton

getComponentInfo, getSrc, setSrc

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

getAccessKey, getButtonValue, getDisabledBecause, getType, isDisabled, setAccessKey, setButtonValue, setDisabled, setDisabled, setDisabledBecause, setType, visit

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

add, add, add, addTable, addTableForLayout, addTableForLayout, appendTreeErrors, canContain, 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

$, acceptRequestParameter, 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, componentHandleWebAction, componentHandleWebDataRequest, createStatement, findComponentBundle, findParent, getActualID, getAllocationTracepoint, getBindingErrors, getBindingList, getBrowserWindowSize, getCalculatedTestID, getClicked, getClientBounds, getComponentBundle, getComponentDataURL, getComponentDataURL, 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, onAddedToPage, onBeforeFullRender, onBeforeRender, onForceRebuild, onHeaderContributors, onRemoveFromPage, 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.IControl

getErrorLocation, hasError, isDisabled, setErrorLocation

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

setDisabled, setTestID

Methods inherited from interface to.etc.domui.dom.errors.INodeErrorDelegate

clearMessage, getMessage, setMessage

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

DEFAULT_COMBO_SIZE

public static final int DEFAULT_COMBO_SIZE

See Also:

Constant Field Values

Constructor Detail

DropDownPicker

public DropDownPicker()

DropDownPicker constructor. By default size of drop down list is DropDownPicker.DEFAULT_COMBO_SIZE.

DropDownPicker

public DropDownPicker(@Nonnull
                      List<T> data)

DropDownPicker constructor. By default size of drop down list is DropDownPicker.DEFAULT_COMBO_SIZE.

Parameters:

data - data for picker popup

DropDownPicker

public DropDownPicker(@Nonnull
                      List<T> data,
                      int size)

DropDownPicker constructor.

Parameters:

data - data for picker popup

size - size of drop down list

Method Detail

createContent

public void createContent()
                   throws Exception

Overrides:

createContent in class SmallImgButton

Throws:

Exception

getSize

public int getSize()

Returns size of drop down list.

Returns:

setSize

public void setSize(int size)

getOffsetX

public int getOffsetX()

Returns custom offset x relative to picker btn.

Returns:

setOffsetX

public void setOffsetX(int offsetX)

Specify custom offset x relative to picker btn. By default, popup is rendered under getAlignmentBase() control.

Parameters:

offsetX -

getOffsetY

public int getOffsetY()

Returns custom offset y relative to getAlignmentBase() control. To set horizontal alignment rule see setHalign(HAlign).

Returns:

setOffsetY

public void setOffsetY(int offsetY)

Specify custom offset y relative to picker btn. By default, popup is rendered under picker button.

Parameters:

offsetX -

setValue

public void setValue(@Nullable
                     T value)

Description copied from interface: IControl

Set a new value into this control. Setting a value to null means the control holds no value. This value is converted to a presentable form using any (implicitly) defined converters; it will not be validated though! This means that if you set an invalid value for a validator this will not be seen until the value is gotten from the control again.

Specified by:

setValue in interface IControl<T>

getValue

@Nullable
public T getValue()

Description copied from interface: IControl

Returns the current value of this input component. If the component contains no value this returns null. All text input components will return null when their value is the empty string! If the component, during conversion or validation of the input value, discovers that the input is invalid it will set itself in "error" mode, post an error message up the form, and throw a ValidationException. This means that this call either delivers correct input (as defined by it's converter and validators), null (when empty) or throws an exception. When a ValidationException occurs the framework mostly ignores it - it does not produce a stacktrace or error in the client. Instead the resulting error as posted by the error handling framework gets displayed on the form when the request completes.

To get the value of a component while ignoring exceptions call IControl.getValueSafe().

Specified by:

getValue in interface IControl<T>

Returns:

getOnBeforeShow

@Nullable
public INotifyEvent<DropDownPicker<T>,ComboLookup<T>> getOnBeforeShow()

setOnBeforeShow

public void setOnBeforeShow(@Nullable
                            INotifyEvent<DropDownPicker<T>,ComboLookup<T>> onBeforeShow)

isMandatory

public boolean isMandatory()

Description copied from interface: IControl

Returns T if this control is a mandatory input.

Specified by:

isMandatory in interface IControl<T>

Returns:

setMandatory

public void setMandatory(boolean mandatory)

Description copied from interface: IControl

Make the control mandatory.

Specified by:

setMandatory in interface IControl<T>

getHalign

@Nonnull
public DropDownPicker.HAlign getHalign()

Horizontal alignment of dropdown popup. By default set to HAlign#Left.

Returns:

setHalign

public void setHalign(@Nonnull
                      DropDownPicker.HAlign halign)

Sets picker select list horizontal alignment.

• DropDownPicker.HAlign.LEFT position list to be left aligned with getAlignmentBase() component.
• DropDownPicker.HAlign.MIDDLE position list to be center aligned with getAlignmentBase() component.
• DropDownPicker.HAlign.RIGHT position list to be right aligned with getAlignmentBase() component.

If no other component is set to be getAlignmentBase(), this defaults to drop down button. In order to affect offset to this aligment rules use setOffsetY(int) and setOffsetX(int).

Parameters:

halign -

getAlignmentBase

@Nullable
public NodeBase getAlignmentBase()

see m_alignmentBase

Parameters:

halignmentBase -

setAlignmentBase

public void setAlignmentBase(@Nullable
                             NodeBase halignmentBase)

see m_alignmentBase

Parameters:

halignmentBase -

getSelectControl

@Nonnull
public Select getSelectControl()
                                 throws Exception

Throws:

Exception

hasData

public boolean hasData()

setData

public void setData(@Nonnull
                    List<T> data)

getOnValueChanged

@Nullable
public IValueChanged<DropDownPicker<T>> getOnValueChanged()

Specified by:

getOnValueChanged in interface IHasChangeListener

setOnValueChanged

public void setOnValueChanged(@Nullable
                              IValueChanged<?> onValueChanged)

Specified by:

setOnValueChanged in interface IHasChangeListener

getValueSafe

public T getValueSafe()

Description copied from interface: IControl

Like IControl.getValue() this returns the value of the component, but this returns null if the value was invalid. For this method NULL either means the value was invalid OR it's content was empty. To distinguish between the two call IControl.hasError() or use IControl.getValue() instead of this call.

Specified by:

getValueSafe in interface IControl<T>

Returns:

isReadOnly

public boolean isReadOnly()

Description copied from interface: IControl

Returns T if the control is currently in readonly mode. Controls that do not have a readonly ability (comboboxes) will use disabled as the readonly state. For those controls the readonly state mirrors the disabled state.

Specified by:

isReadOnly in interface IControl<T>

Returns:

setReadOnly

public void setReadOnly(boolean ro)

Description copied from interface: IControl

Sets the input to readonly-mode. Components that do not implement readonly mode (comboboxes) will usually set themselves to disabled which works much the same.

Specified by:

setReadOnly in interface IControl<T>