to.etc.domui.component2.lookupinput

Class LookupInputBase2<QT,OT>

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.component2.lookupinput.LookupInputBase2<QT,OT>

All Implemented Interfaces:

Iterable<NodeBase>, IQueryManipulator<QT>, ITypedControl<OT>, INodeErrorDelegate, IActionControl, IControl<OT>, IHasChangeListener, IHasModifiedIndication, IDraggable, IDropBody, IDropTargetable

Direct Known Subclasses:

LookupInput2

public abstract class LookupInputBase2<QT,OT>
extends Div
implements IControl<OT>, ITypedControl<OT>, IHasModifiedIndication, IQueryManipulator<QT>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	LookupInputBase2.IPopupOpener EXPERIMENTAL Factory for the lookup dialog, to be shown when the lookup button is pressed.

Constructor Summary

Constructors

Constructor and Description
LookupInputBase2(ITableModelFactory<QT,OT> modelFactory, Class<QT> queryClass, Class<OT> resultClass) Lookup a POJO Java bean persistent class.
LookupInputBase2(ITableModelFactory<QT,OT> modelFactory, Class<QT> queryClass, Class<OT> resultClass, ClassMetaModel queryMetaModel, ClassMetaModel outputMetaModel)
LookupInputBase2(ITableModelFactory<QT,OT> modelFactory, QCriteria<QT> rootCriteria, Class<OT> resultClass)

Method Summary

Modifier and Type	Method and Description
void	addKeywordProperty(String name) Define a property to use for quick search.
void	addKeywordProperty(String name, int minlen) Define a property to use for quick search.
QCriteria<QT>	adjustQuery(QCriteria<QT> enteredCriteria) Adjust the query.
void	createContent()
Class<OT>	getActualType()
OT	getBindValue()
HoverButton	getClearButton()
String	getDefaultTitle() Construct a default title for this LookupInput
String	getDisabledBecause()
protected String	getFocusID() Depending on what is present return the ID of a component that can receive focus.
String	getKeySearchHint() Getter for keyword search hint.
List<SearchPropertyMetaModel>	getKeywordLookupPropertyList()
String	getKeyWordSearchCssClass()
int	getKeyWordSearchPopupWidth()
ITableModelFactory<QT,OT>	getModelFactory()
INotify<Dialog>	getOnPopupOpen()
IValueChanged<?>	getOnValueChanged()
Class<OT>	getOutputClass()
ClassMetaModel	getOutputMetaModel()
LookupInputBase2.IPopupOpener	getPopupOpener()
Class<QT>	getQueryClass()
IQueryHandler<QT>	getQueryHandler() The query handler to use.
IQueryManipulator<QT>	getQueryManipulator() When set the specified manipulator will be called before a query is sent to the database.
ClassMetaModel	getQueryMetaModel()
IStringQueryFactory<QT>	getStringQueryFactory()
OT	getValue() Returns the current value of this input component.
INodeContentRenderer<OT>	getValueRenderer() The content renderer to use to render the current value.
OT	getValueSafe() Like IControl.getValue() this returns the value of the component, but this returns null if the value was invalid.
OT	getWorkValue() The value without any consequences
boolean	hasError() Return T if this node currently has an error associated with it.
boolean	isAllowKeyWordSearch() Getter for property m_allowKeyWordSearch.
boolean	isDisabled() Returns T if the control is currently in disabled.
boolean	isFocusable()
boolean	isMandatory() Returns T if this control is a mandatory input.
boolean	isModified() Returns the modified-by-user flag.
protected boolean	isPopupShown() Define the full column spec in the format described for BasicRowRenderer for the dropdown box showing quick search results.
boolean	isReadOnly() Returns T if the control is currently in readonly mode.
void	setAllowKeyWordSearch(boolean allowKeyWordSearch) Setter for property m_allowKeyWordSearch.
void	setBindValue(OT value)
void	setDefaultTitle(String defaultTitle)
void	setDialogSelection(OT value) EXPERIMENTAL This callback must be called by the popup once a selection is made.
void	setDisabled(boolean disabled) Set the input to disabled mode.
void	setDisabledBecause(String msg)
void	setFocus() Claim the focus for this component.
void	setHint(String text) Set a hint text for this control, for some reason only on the select button??
void	setKeySearchHint(String keySearchHint) Set hint to keyword search input.
void	setKeyWordSearchCssClass(String cssClass) Set custom css that would be applied only in case that component is rendering keyWordSearch.
void	setKeyWordSearchPopupWidth(int keyWordSearchPopupWidth)
void	setKeywordSearchProperties(List<SearchPropertyMetaModel> keywordLookupPropertyList) Not normally used; use addKeywordProperty(String, int) instead.
void	setMandatory(boolean mandatory) Make the control mandatory.
void	setModelFactory(ITableModelFactory<QT,OT> modelFactory)
void	setModified(boolean as) Set or clear the modified by user flag.
void	setOnPopupOpen(INotify<Dialog> onPopupOpen)
void	setOnValueChanged(IValueChanged<?> onValueChanged)
void	setPopupOpener(LookupInputBase2.IPopupOpener popupOpener)
void	setQueryHandler(IQueryHandler<QT> queryHandler)
void	setQueryManipulator(IQueryManipulator<QT> queryManipulator) When set the specified manipulator will be called before a query is sent to the database.
void	setReadOnly(boolean readOnly) Sets the input to readonly-mode.
void	setStringQueryFactory(IStringQueryFactory<QT> keyWordSearchManipulator)
void	setValue(OT v) Set a new value into this control.
void	setValueColumns(String... columns) Define the columns to show in "display current value" mode.
void	setValueRenderer(INodeContentRenderer<OT> contentRenderer)
void	showResults(ITableModel<OT> model)

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

LookupInputBase2

public LookupInputBase2(@Nonnull
                        ITableModelFactory<QT,OT> modelFactory,
                        @Nonnull
                        Class<QT> queryClass,
                        @Nonnull
                        Class<OT> resultClass)

Lookup a POJO Java bean persistent class.

Parameters:

queryClass -

LookupInputBase2

public LookupInputBase2(@Nonnull
                        ITableModelFactory<QT,OT> modelFactory,
                        @Nonnull
                        QCriteria<QT> rootCriteria,
                        @Nonnull
                        Class<OT> resultClass)

LookupInputBase2

public LookupInputBase2(@Nonnull
                        ITableModelFactory<QT,OT> modelFactory,
                        @Nonnull
                        Class<QT> queryClass,
                        @Nonnull
                        Class<OT> resultClass,
                        @Nullable
                        ClassMetaModel queryMetaModel,
                        @Nullable
                        ClassMetaModel outputMetaModel)

Method Detail

getClearButton

@Nonnull
public HoverButton getClearButton()

createContent

public void createContent()
                   throws Exception

Overrides:

createContent in class NodeBase

Throws:

Exception

getFocusID

@Nullable
protected String getFocusID()

Depending on what is present return the ID of a component that can receive focus.

Overrides:

getFocusID in class NodeBase

Returns:

adjustQuery

@Nullable
public QCriteria<QT> adjustQuery(@Nonnull
                                           QCriteria<QT> enteredCriteria)

Description copied from interface: IQueryManipulator

Adjust the query. If the query is to be cancelled this should return null.

Specified by:

adjustQuery in interface IQueryManipulator<QT>

Returns:

getOnPopupOpen

@Nullable
public INotify<Dialog> getOnPopupOpen()

setOnPopupOpen

public void setOnPopupOpen(@Nullable
                           INotify<Dialog> onPopupOpen)

showResults

public void showResults(@Nullable
                        ITableModel<OT> model)
                 throws Exception

Throws:

Exception

getDefaultTitle

@Nonnull
public String getDefaultTitle()

Construct a default title for this LookupInput

Returns:

setDefaultTitle

public void setDefaultTitle(@Nullable
                            String defaultTitle)

setHint

public void setHint(@Nonnull
                    String text)

Set a hint text for this control, for some reason only on the select button??

Parameters:

text -

isMandatory

public boolean isMandatory()

Returns T if this control is a mandatory input.

Specified by:

isMandatory in interface IControl<OT>

Returns:

setMandatory

public void setMandatory(boolean mandatory)

Make the control mandatory.

Specified by:

setMandatory in interface IControl<OT>

isReadOnly

public boolean isReadOnly()

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

Returns:

setReadOnly

public void setReadOnly(boolean readOnly)

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

isDisabled

public boolean isDisabled()

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

Returns:

setDisabled

public void setDisabled(boolean disabled)

Set the input to disabled mode.

Specified by:

setDisabled in interface IActionControl

getDisabledBecause

@Nullable
public String getDisabledBecause()

setDisabledBecause

public void setDisabledBecause(@Nullable
                               String msg)

getBindValue

@Nullable
public OT getBindValue()

setBindValue

public void setBindValue(@Nullable
                         OT value)

getValue

@Nullable
public OT getValue()

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

Returns:

getValueSafe

@Nullable
public OT getValueSafe()

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

Returns:

getWorkValue

public OT getWorkValue()

The value without any consequences

Returns:

hasError

public boolean hasError()

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

Specified by:

hasError in interface IControl<OT>

Overrides:

hasError in class NodeContainer

Returns:

setValue

public void setValue(@Nullable
                     OT v)

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

setDialogSelection

public final void setDialogSelection(@Nullable
                                     OT value)
                              throws Exception

EXPERIMENTAL This callback must be called by the popup once a selection is made.

Parameters:

value -

Throws:

Exception

getOnValueChanged

@Nullable
public IValueChanged<?> getOnValueChanged()

Specified by:

getOnValueChanged in interface IHasChangeListener

setOnValueChanged

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

Specified by:

setOnValueChanged in interface IHasChangeListener

getQueryManipulator

@Nullable
public IQueryManipulator<QT> getQueryManipulator()

When set the specified manipulator will be called before a query is sent to the database. The query can be altered to add extra restrictions for instance.

Returns:

getQueryHandler

@Nonnull
public IQueryHandler<QT> getQueryHandler()

The query handler to use. The default query handler PageQueryHandler will use the normal conversation-associated DataContext to issue the query.

Returns:

setQueryHandler

public void setQueryHandler(@Nullable
                            IQueryHandler<QT> queryHandler)

setQueryManipulator

public void setQueryManipulator(@Nullable
                                IQueryManipulator<QT> queryManipulator)

When set the specified manipulator will be called before a query is sent to the database. The query can be altered to add extra restrictions for instance.

Parameters:

queryManipulator -

isModified

public boolean isModified()

Returns the modified-by-user flag.

Specified by:

isModified in interface IHasModifiedIndication

See Also:

IHasModifiedIndication.isModified()

setModified

public void setModified(boolean as)

Set or clear the modified by user flag.

Specified by:

setModified in interface IHasModifiedIndication

See Also:

IHasModifiedIndication.setModified(boolean)

getStringQueryFactory

@Nonnull
public IStringQueryFactory<QT> getStringQueryFactory()

setStringQueryFactory

public void setStringQueryFactory(@Nonnull
                                  IStringQueryFactory<QT> keyWordSearchManipulator)

getKeyWordSearchCssClass

@Nullable
public String getKeyWordSearchCssClass()

setKeyWordSearchCssClass

public void setKeyWordSearchCssClass(@Nullable
                                     String cssClass)

Set custom css that would be applied only in case that component is rendering keyWordSearch. Used for example in row inline rendering, where width and min-width should be additionaly customized.

Parameters:

cssClass -

isAllowKeyWordSearch

public boolean isAllowKeyWordSearch()

Getter for property m_allowKeyWordSearch.

Returns:

setAllowKeyWordSearch

public void setAllowKeyWordSearch(boolean allowKeyWordSearch)

Setter for property m_allowKeyWordSearch.

getKeySearchHint

@Nullable
public String getKeySearchHint()

Getter for keyword search hint. See setKeySearchHint(java.lang.String).

setKeySearchHint

public void setKeySearchHint(@Nullable
                             String keySearchHint)

Set hint to keyword search input. Usually says how search condition is resolved.

Parameters:

keySearchHint -

addKeywordProperty

public void addKeywordProperty(@Nonnull
                               String name,
                               int minlen)

Define a property to use for quick search. When used this overrides any metadata-defined properties.

Parameters:

name -

minlen -

setKeywordSearchProperties

public void setKeywordSearchProperties(@Nonnull
                                       List<SearchPropertyMetaModel> keywordLookupPropertyList)

Not normally used; use addKeywordProperty(String, int) instead.

Parameters:

keywordLookupPropertyList -

getKeywordLookupPropertyList

@Nonnull
public List<SearchPropertyMetaModel> getKeywordLookupPropertyList()

addKeywordProperty

public void addKeywordProperty(@Nonnull
                               String name)

Define a property to use for quick search. When used this overrides any metadata-defined properties.

Parameters:

name -

getKeyWordSearchPopupWidth

public int getKeyWordSearchPopupWidth()

setKeyWordSearchPopupWidth

public void setKeyWordSearchPopupWidth(int keyWordSearchPopupWidth)

getOutputClass

@Nonnull
public Class<OT> getOutputClass()

getActualType

@Nonnull
public Class<OT> getActualType()

Specified by:

getActualType in interface ITypedControl<OT>

getQueryClass

@Nonnull
public Class<QT> getQueryClass()

getOutputMetaModel

@Nonnull
public ClassMetaModel getOutputMetaModel()

getQueryMetaModel

@Nonnull
public ClassMetaModel getQueryMetaModel()

setValueColumns

public void setValueColumns(String... columns)

Define the columns to show in "display current value" mode. This actually creates a content renderer (a SimpleLookupInputRenderer2) to render the fields.

Parameters:

columns -

getValueRenderer

@Nullable
public INodeContentRenderer<OT> getValueRenderer()

The content renderer to use to render the current value.

Returns:

setValueRenderer

public void setValueRenderer(@Nullable
                             INodeContentRenderer<OT> contentRenderer)

isPopupShown

protected boolean isPopupShown()

Define the full column spec in the format described for BasicRowRenderer for the dropdown box showing quick search results.

Parameters:

columns -

isFocusable

public boolean isFocusable()

Overrides:

isFocusable in class NodeBase

setFocus

public void setFocus()

Description copied from class: NodeBase

Claim the focus for this component. Only reasonable for input type and action components (links, buttons). For now this can only be called for components that are already attached to a page. If this is a proble I'll fix it. Only one component in a page can claim focus for itself.

Overrides:

setFocus in class NodeBase

getModelFactory

@Nonnull
public ITableModelFactory<QT,OT> getModelFactory()

setModelFactory

public void setModelFactory(@Nonnull
                            ITableModelFactory<QT,OT> modelFactory)

getPopupOpener

@Nullable
public LookupInputBase2.IPopupOpener getPopupOpener()

setPopupOpener

public void setPopupOpener(LookupInputBase2.IPopupOpener popupOpener)