to.etc.domui.pages.generic

Class BasicListPage<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.dom.html.UrlPage

to.etc.domui.pages.generic.BasicPage<T>

to.etc.domui.pages.generic.BasicListPage<T>

All Implemented Interfaces:

Iterable<NodeBase>, INodeErrorDelegate, IDraggable, IDropBody, IDropTargetable

public abstract class BasicListPage<T>
extends BasicPage<T>

Generic page handling some cruddy stuff. FIXME Example only; VP specific one should exist.

Author:

vmijic Created on 29 Jul 2009

Constructor Summary

Constructors

Constructor and Description
BasicListPage(Class<T> clz)
BasicListPage(Class<T> baseClass, String txt)

Method Summary

Modifier and Type	Method and Description
protected void	adjustCriteria(QCriteria<T> crit)
void	createContent()
protected void	customizeLookupForm(LookupForm<T> lf) Override this to customize the lookup form.
protected LookupForm<T>	getLookupForm()
protected IQueryHandler<T>	getQueryHandler()
IRowRenderer<T>	getRowRenderer() Get the row renderer to use for the request.
boolean	hasEditRight()
boolean	isAllowEmptySearch() When set to T this allows searching a set without any specified criteria.
boolean	isSearchImmediately() When set to TRUE this makes the form immediately execute a query with all empty lookup fields, meaning it will immediately show a list of rows.
protected void	onLookupFormClear(LookupForm<T> lf) Override to do extra things when the lookupform's "clear" button is pressed.
protected abstract void	onNew() Implement to handle pressing the "new record" button.
abstract void	onSelect(T rcord) Implement to handle a selection of a record that was found.
protected void	onShelve()
void	setAllowEmptySearch(boolean allowEmptySearch) When set to T this allows searching a set without any specified criteria.
protected void	setLookupForm(LookupForm<T> lookupForm)
protected void	setQueryHandler(IQueryHandler<T> queryHandler)
void	setRowRenderer(IRowRenderer<T> rr) Override to provide your own Row Renderer.
void	setSearchImmediately(boolean searchImmediately) When set to TRUE this makes the form immediately execute a query with all empty lookup fields, meaning it will immediately show a list of rows.

Methods inherited from class to.etc.domui.pages.generic.BasicPage

addPageHeaders, addPageTitleBar, clearGlobalMessages, getBaseClass, getBaseClassBundle, getClassBundle, getPropertyModel, getTitleBar, setPageTitle

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

closeWindow, componentHandleWebAction, fixStretchBody, fixStretchBodyUnkludged, forceReloadData, getNotifyPageEvent, getPageTitle, getSharedContext, getSharedContext, getSharedContextFactory, getSharedContextFactory, getTestRepeatId, getThemeVariant, lc, onDestroy, onForceRebuild, onReload, resetAllSharedContexts, setNotifyPageEvent, setThemeVariant, unkludge

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

afterCreateContent, 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, getSpecialAttribute, getSpecialAttributeList, getTag, getTestID, getThemedResourceRURL, getTitle, getUserObject, handleDrop, hasCssClass, hasParent, internalGetOldParent, internalGetParent, internalHasChangedAttributes, internalNeedClickHandler, internalOnClicked, internalOnValueChanged, internalRenderJavascriptDelta, internalRenderJavascriptState, internalSetHasChangedAttributes, internalSetHasChangedAttributes, internalSetLogAllocations, internalSetTag, isAttached, isBuilt, isFocusable, isFocusRequested, isRendersOwnClose, isStretchHeight, notify, notifyParentOrOpenerPage, onAddedToPage, onBeforeFullRender, onBeforeRender, onHeaderContributors, onRemoveFromPage, 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 java.lang.Iterable

forEach, spliterator

Constructor Detail

BasicListPage

public BasicListPage(Class<T> clz)

BasicListPage

public BasicListPage(Class<T> baseClass,
                     String txt)

Method Detail

onSelect

public abstract void onSelect(@Nonnull
                              T rcord)
                       throws Exception

Implement to handle a selection of a record that was found.

Parameters:

rcord -

Throws:

Exception

onNew

protected abstract void onNew()
                       throws Exception

Implement to handle pressing the "new record" button.

Throws:

Exception

customizeLookupForm

protected void customizeLookupForm(@Nonnull
                                   LookupForm<T> lf)
                            throws Exception

Override this to customize the lookup form. No need to call super. method.

Parameters:

lf -

Throws:

Exception

createContent

public void createContent()
                   throws Exception

Overrides:

createContent in class BasicPage<T>

Throws:

Exception

adjustCriteria

protected void adjustCriteria(@Nonnull
                              QCriteria<T> crit)

onShelve

protected void onShelve()
                 throws Exception

Overrides:

onShelve in class NodeBase

Throws:

Exception

onLookupFormClear

protected void onLookupFormClear(LookupForm<T> lf)
                          throws Exception

Override to do extra things when the lookupform's "clear" button is pressed. Can be used to set items to defaults after their input has been cleared. When this is called all inputs in the form have already been set to null (empty) - so do not call LookupForm.clearInput().

Parameters:

lf -

Throws:

Exception

getRowRenderer

public IRowRenderer<T> getRowRenderer()
                               throws Exception

Get the row renderer to use for the request.

Returns:

Throws:

Exception

setRowRenderer

public void setRowRenderer(IRowRenderer<T> rr)

Override to provide your own Row Renderer. If not set a BasicRowRenderer with reasonable defaults will be created for you.

isSearchImmediately

public boolean isSearchImmediately()

When set to TRUE this makes the form immediately execute a query with all empty lookup fields, meaning it will immediately show a list of rows.

Returns:

setSearchImmediately

public void setSearchImmediately(boolean searchImmediately)

When set to TRUE this makes the form immediately execute a query with all empty lookup fields, meaning it will immediately show a list of rows.

Parameters:

showDefaultSearch -

isAllowEmptySearch

public boolean isAllowEmptySearch()

When set to T this allows searching a set without any specified criteria.

Returns:

setAllowEmptySearch

public void setAllowEmptySearch(boolean allowEmptySearch)

When set to T this allows searching a set without any specified criteria.

Parameters:

allowEmptySearch -

hasEditRight

public boolean hasEditRight()

getLookupForm

protected LookupForm<T> getLookupForm()

setLookupForm

protected void setLookupForm(LookupForm<T> lookupForm)

getQueryHandler

protected IQueryHandler<T> getQueryHandler()

setQueryHandler

protected void setQueryHandler(IQueryHandler<T> queryHandler)