to.etc.domui.component.combobox

Class ComboBoxBase<T,V>

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

to.etc.domui.component.combobox.ComboBoxBase<T,V>

All Implemented Interfaces:

Iterable<NodeBase>, INodeErrorDelegate, IActionControl, IControl<V>, IHasChangeListener, IDraggable, IDropBody, IDropTargetable

Direct Known Subclasses:

SelectFixed

public class ComboBoxBase<T,V>
extends Div
implements IControl<V>

Constructor Summary

Constructors

Constructor and Description
ComboBoxBase()
ComboBoxBase(IComboDataSet<T> dataSet)
ComboBoxBase(IListMaker<T> maker)
ComboBoxBase(List<T> in)
ComboBoxBase(QCriteria<T> query)

Method Summary

Modifier and Type	Method and Description
void	createContent() Render the actual combobox.
INodeContentRenderer<T>	getContentRenderer()
Class<? extends INodeContentRenderer<T>>	getContentRendererClass()
List<T>	getData() Returns the data to use as the list-of-values of this combo.
protected to.etc.domui.component.combobox.ComboOption<T>	getEmptyOption() If this combobox has a "unselected" option currently this contains that option.
String	getEmptyText()
IListMaker<T>	getListMaker()
IValueChanged<?>	getOnValueChanged()
PropertyMetaModel<?>	getPropertyMetaModel()
int	getSelectedIndex()
V	getValue() Returns the current value of this input component.
V	getValueSafe() Like IControl.getValue() this returns the value of the component, but this returns null if the value was invalid.
IValueTransformer<V>	getValueTransformer()
boolean	hasError() Return T if this node currently has an error associated with it.
protected V	internalGetCurrentValue()
protected boolean	internalOnUserInput(int oldindex, int nindex) The user selected a different option.
boolean	isDisabled() Returns T if the control is currently in disabled.
boolean	isMandatory() Returns T if this control is a mandatory input.
boolean	isReadOnly() Returns T if the control is currently in readonly mode.
protected V	listToValue(T in)
protected List<T>	provideData() Creates the list-of-values that is to be used if no specific lov is set using setData().
protected void	renderOptionLabel(to.etc.domui.component.combobox.ComboOption<T> o)
protected void	renderOptionLabel(NodeContainer into, to.etc.domui.component.combobox.ComboOption<T> o)
void	setContentRenderer(INodeContentRenderer<T> contentRenderer)
void	setContentRendererClass(Class<? extends INodeContentRenderer<T>> contentRendererClass)
void	setData(List<T> data) Can be used to set a specific list-of-values.
void	setDisabled(boolean disabled) Set the input to disabled mode.
protected void	setEmptyOption(to.etc.domui.component.combobox.ComboOption<T> emptyOption) See getter.
void	setEmptyText(String emptyText)
void	setListMaker(IListMaker<T> listMaker)
void	setMandatory(boolean mandatory) Make the control mandatory.
void	setOnValueChanged(IValueChanged<?> onValueChanged)
void	setPropertyMetaModel(PropertyMetaModel<?> propertyMetaModel)
void	setReadOnly(boolean readOnly) Sets the input to readonly-mode.
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	setValue(V v) Set the combo to the specified value.
void	setValueTransformer(IValueTransformer<V> valueTransformer)

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

afterCreateContent, componentHandleWebAction, fadeIn, fadeOut, getCustomUpdatesCallJS, getDragHandler, getDropBody, getDropHandler, getDropMode, getReturnPressed, setDragHandler, setDropBody, setDropHandler, setReturnPressed, slideDown, slideUp, tb, 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, 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, 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, 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, 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, setErrorLocation

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

setTestID

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

clearMessage, getMessage, setMessage

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

ComboBoxBase

public ComboBoxBase()

ComboBoxBase

public ComboBoxBase(@Nonnull
                    IListMaker<T> maker)

ComboBoxBase

public ComboBoxBase(@Nonnull
                    IComboDataSet<T> dataSet)

ComboBoxBase

public ComboBoxBase(@Nonnull
                    QCriteria<T> query)

ComboBoxBase

public ComboBoxBase(@Nonnull
                    List<T> in)

Method Detail

createContent

public void createContent()
                   throws Exception

Render the actual combobox. This renders the value domain as follows:

• If the combobox is optional then the value list will always start with an "unselected" option which will be shown if the value is null.
• If the combobox is mandatory but it's current value is not part of the value domain (i.e. it is null, or the value cannot be found in the list of values) then it also renders an initial "unselected" option value which will become selected.
• For a mandatory combo with a valid value the "empty" choice will not be rendered.

Fixes bug# 790.

Overrides:

createContent in class NodeBase

Throws:

Exception

getSelectedIndex

public int getSelectedIndex()

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 -

getValue

public final V 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<V>

Returns:

See Also:

IControl.getValue()

setValue

public final void setValue(@Nullable
                           V v)

Set the combo to the specified value. The value must be in the domain specified by the data list and must be findable in that list; if not the results are undefined. If the value set is null and the combobox is a mandatory one the code will check if an "unselected" item is present to select. If not the unselected item will be added by this call(!).

Specified by:

setValue in interface IControl<V>

See Also:

IControl.setValue(java.lang.Object)

internalOnUserInput

protected boolean internalOnUserInput(int oldindex,
                                      int nindex)

The user selected a different option.

See Also:

Select.internalOnUserInput(int, int)

listToValue

protected V listToValue(T in)
                 throws Exception

Parameters:

in -

Returns:

Throws:

Exception

renderOptionLabel

protected void renderOptionLabel(@Nonnull
                                 to.etc.domui.component.combobox.ComboOption<T> o)
                          throws Exception

Throws:

Exception

renderOptionLabel

protected void renderOptionLabel(@Nonnull
                                 NodeContainer into,
                                 @Nonnull
                                 to.etc.domui.component.combobox.ComboOption<T> o)
                          throws Exception

Throws:

Exception

setData

public void setData(List<T> data)

Can be used to set a specific list-of-values. When called this clears the existing dataset.

Parameters:

data -

getData

@Nonnull
public List<T> getData()
                         throws Exception

Returns the data to use as the list-of-values of this combo. This must contain actual selectable values only, it may not contain a "no selection made" value thingerydoo.

Returns:

Throws:

Exception

provideData

@Nonnull
protected List<T> provideData()
                                throws Exception

Creates the list-of-values that is to be used if no specific lov is set using setData(). The default implementation walks the data providers to see if one is present.

Returns:

Throws:

Exception

getValueSafe

public V 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<V>

Returns:

See Also:

IControl.getValueSafe()

hasError

public boolean hasError()

Description copied from class: NodeBase

Return T if this node currently has an error associated with it.

Specified by:

hasError in interface IControl<V>

Overrides:

hasError in class NodeContainer

Returns:

See Also:

IControl.hasError()

getContentRenderer

public INodeContentRenderer<T> getContentRenderer()

setContentRenderer

public void setContentRenderer(INodeContentRenderer<T> contentRenderer)

getContentRendererClass

public Class<? extends INodeContentRenderer<T>> getContentRendererClass()

setContentRendererClass

public void setContentRendererClass(Class<? extends INodeContentRenderer<T>> contentRendererClass)

getPropertyMetaModel

public PropertyMetaModel<?> getPropertyMetaModel()

setPropertyMetaModel

public void setPropertyMetaModel(PropertyMetaModel<?> propertyMetaModel)

getListMaker

public IListMaker<T> getListMaker()

setListMaker

public void setListMaker(IListMaker<T> listMaker)

getValueTransformer

public IValueTransformer<V> getValueTransformer()

setValueTransformer

public void setValueTransformer(IValueTransformer<V> valueTransformer)

getEmptyText

public String getEmptyText()

setEmptyText

public void setEmptyText(String emptyText)

getEmptyOption

@Nullable
protected to.etc.domui.component.combobox.ComboOption<T> getEmptyOption()

If this combobox has a "unselected" option currently this contains that option. When present it means that indexes in the combo list are one higher than indexes in the backing dataset (because this empty option is always choice# 0).

Returns:

setEmptyOption

protected void setEmptyOption(to.etc.domui.component.combobox.ComboOption<T> emptyOption)

See getter.

Parameters:

emptyOption -

internalGetCurrentValue

@Nullable
protected V internalGetCurrentValue()

setMandatory

public void setMandatory(boolean mandatory)

Description copied from interface: IControl

Make the control mandatory.

Specified by:

setMandatory in interface IControl<V>

isDisabled

public boolean isDisabled()

Description copied from interface: IControl

Returns T if the control is currently in disabled. 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:

isDisabled in interface IControl<V>

Returns:

setDisabled

public void setDisabled(boolean disabled)

Description copied from interface: IActionControl

Set the input to disabled mode.

Specified by:

setDisabled in interface IActionControl

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<V>

Returns:

setReadOnly

public void setReadOnly(boolean readOnly)

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<V>

isMandatory

public boolean isMandatory()

Description copied from interface: IControl

Returns T if this control is a mandatory input.

Specified by:

isMandatory in interface IControl<V>

Returns:

getOnValueChanged

public IValueChanged<?> getOnValueChanged()

Specified by:

getOnValueChanged in interface IHasChangeListener

See Also:

IHasChangeListener.getOnValueChanged()

setOnValueChanged

public void setOnValueChanged(IValueChanged<?> onValueChanged)

Specified by:

setOnValueChanged in interface IHasChangeListener

See Also:

IHasChangeListener.setOnValueChanged(to.etc.domui.dom.html.IValueChanged)