to.etc.domui.component.input

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

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

All Implemented Interfaces:

Iterable<NodeBase>, ITypedControl<T>, INodeErrorDelegate, IActionControl, IControl<List<T>>, IHasChangeListener, IDraggable, IDropBody, IDropTargetable

public class MultipleLookupInput<T>
extends Div
implements IControl<List<T>>, ITypedControl<T>

Component that is based on LookupInput, that allows multiple selection of items by adding found items into selection box. By default selected items are rendered as spans with caption and close button that removes them from selection.

Author:

Vladimir Mijic Created on 13 Oct 2011

Constructor Summary

Constructors

Constructor and Description
MultipleLookupInput(Class<T> clazz, String... renderColumns)

Method Summary

Modifier and Type	Method and Description
void	addSelection(T item)
protected void	applyIE10Workaround() There is a problem in Internet Explorer 10 with min and max height parameters for empty div. The problem occurs when container have scroller (bigger than max height) and than it's cleared.
protected void	clearSelection(Object object)
void	createContent()
void	endUpdate() Call to mark end selection update changes.
Class<T>	getActualType()
List<T>	getBindValue()
String	getCssForSelectedItems()
String	getCssForSelectionContainer()
LookupInput<T>	getLookupInput()
String	getMaxHeightForSelectionContainer()
LookupInput<T>	getMultipleLookupInput()
IValueChanged<?>	getOnValueChanged()
String[]	getRenderColumns()
INodeContentRenderer<T>	getSelectedItemContentRenderer()
List<T>	getValue() Returns the current value of this input component.
List<T>	getValueSafe() Like IControl.getValue() this returns the value of the component, but this returns null if the value was invalid.
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.
void	removeItem(T item) Remove item from selection list.
void	setBindValue(List<T> value)
void	setCssForSelectedItems(String cssForSelectedItems)
void	setCssForSelectionContainer(String cssForSelectionContainer)
void	setDisabled(boolean d) Set the input to disabled mode.
void	setMandatory(boolean mandatory) Make the control mandatory.
void	setMaxHeightForSelectionContainer(String height)
void	setOnValueChanged(IValueChanged<?> onValueChanged)
void	setReadOnly(boolean ro) Sets the input to readonly-mode.
void	setRenderColumns(String[] renderColumns)
void	setSearchImmediately(boolean searchImmediately)
void	setSelectedItemContentRenderer(INodeContentRenderer<T> render)
void	setValue(List<T> v) Set a new value into this control.
void	startUpdate() Call once you want to mark start of selection update.
protected void	updateClearButtonState()

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, 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, 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, hasError, 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

MultipleLookupInput

public MultipleLookupInput(@Nonnull
                           Class<T> clazz,
                           String... renderColumns)

Method Detail

getActualType

@Nonnull
public Class<T> getActualType()

Specified by:

getActualType in interface ITypedControl<T>

clearSelection

protected void clearSelection(Object object)
                       throws Exception

Throws:

Exception

applyIE10Workaround

protected void applyIE10Workaround()

There is a problem in Internet Explorer 10 with min and max height parameters for empty div.
The problem occurs when container have scroller (bigger than max height) and than it's cleared.

createContent

public void createContent()
                   throws Exception

Overrides:

createContent in class NodeBase

Throws:

Exception

addSelection

public void addSelection(T item)
                  throws Exception

Throws:

Exception

startUpdate

public void startUpdate()

Call once you want to mark start of selection update. Follow with endUpdate once whole change is done in order to trigger UI needed changes.

endUpdate

public void endUpdate()
               throws Exception

Call to mark end selection update changes. See also startUpdate.

Throws:

Exception

getMultipleLookupInput

@Nonnull
public LookupInput<T> getMultipleLookupInput()

updateClearButtonState

protected void updateClearButtonState()

getLookupInput

public LookupInput<T> getLookupInput()

getValueSafe

public List<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<List<T>>

Returns:

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<List<T>>

Returns:

isMandatory

public boolean isMandatory()

Description copied from interface: IControl

Returns T if this control is a mandatory input.

Specified by:

isMandatory in interface IControl<List<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<List<T>>

Returns:

setMandatory

public void setMandatory(boolean mandatory)

Description copied from interface: IControl

Make the control mandatory.

Specified by:

setMandatory in interface IControl<List<T>>

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<List<T>>

getValue

public List<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<List<T>>

Returns:

setValue

public void setValue(@Nullable
                     List<T> v)

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<List<T>>

setDisabled

public void setDisabled(boolean d)

Description copied from interface: IActionControl

Set the input to disabled mode.

Specified by:

setDisabled in interface IActionControl

getOnValueChanged

public IValueChanged<?> getOnValueChanged()

Specified by:

getOnValueChanged in interface IHasChangeListener

setOnValueChanged

public void setOnValueChanged(IValueChanged<?> onValueChanged)

Specified by:

setOnValueChanged in interface IHasChangeListener

getSelectedItemContentRenderer

public INodeContentRenderer<T> getSelectedItemContentRenderer()

setSelectedItemContentRenderer

public void setSelectedItemContentRenderer(INodeContentRenderer<T> render)

getRenderColumns

public String[] getRenderColumns()

setRenderColumns

public void setRenderColumns(String[] renderColumns)

getCssForSelectedItems

public String getCssForSelectedItems()

setCssForSelectedItems

public void setCssForSelectedItems(String cssForSelectedItems)

getCssForSelectionContainer

public String getCssForSelectionContainer()

setCssForSelectionContainer

public void setCssForSelectionContainer(String cssForSelectionContainer)

getMaxHeightForSelectionContainer

public String getMaxHeightForSelectionContainer()

setMaxHeightForSelectionContainer

public void setMaxHeightForSelectionContainer(String height)

removeItem

public void removeItem(T item)
                throws Exception

Remove item from selection list.

Parameters:

item -

Throws:

Exception

setSearchImmediately

public void setSearchImmediately(boolean searchImmediately)

getBindValue

@Nullable
public List<T> getBindValue()

setBindValue

public void setBindValue(@Nullable
                         List<T> value)