to.etc.domui.component.tbl

Class ListShuttle

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.tbl.ListShuttle

All Implemented Interfaces:

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

public class ListShuttle
extends Div
implements ITableModelListener<Object>

The ListShuttle component contains a SOURCE list and a TARGET list, and allows the user to "shuttle" elements from the SOURCE list to the TARGET list, and v.v. In addition the target list can be ordered, if necessary.

Author:

Frits Jalvingh Created on Nov 5, 2008

Constructor Summary

Constructors

Constructor and Description
ListShuttle()

Method Summary

Modifier and Type	Method and Description
void	createContent()
IShuttleModel<?,?>	getModel() Get the model for this thingy.
INodeContentRenderer<Object>	getSourceRenderer()
Class<? extends INodeContentRenderer<?>>	getSourceRendererClass()
INodeContentRenderer<Object>	getTargetRenderer()
Class<? extends INodeContentRenderer<?>>	getTargetRendererClass()
boolean	isOrderable() Is this set to be orderable?
void	modelChanged(ITableModel<Object> model) The source model has changed.
void	rowAdded(ITableModel<Object> model, int index, Object value) A row was moved (back) to the source model: change it.
void	rowDeleted(ITableModel<Object> model, int index, Object value) Called after a row has been deleted.
void	rowModified(ITableModel<Object> model, int index, Object value) Called after a row has been changed.
void	setModel(IShuttleModel<?,?> model) Set the model to use for the shuttle.
void	setOrderable(boolean orderable) When set (and the model supports it) this shows ordering buttons at the right of the target shuttle, allowing the content to be moved up- and downwards.
void	setSourceRenderer(INodeContentRenderer<Object> sourceRenderer)
void	setSourceRendererClass(Class<? extends INodeContentRenderer<?>> sourceRendererClass)
void	setTargetRenderer(INodeContentRenderer<Object> targetRenderer)
void	setTargetRendererClass(Class<? extends INodeContentRenderer<?>> targetRendererClass)

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 java.lang.Iterable

forEach, spliterator

Constructor Detail

ListShuttle

public ListShuttle()

Method Detail

createContent

public void createContent()
                   throws Exception

Overrides:

createContent in class NodeBase

Throws:

Exception

getModel

public IShuttleModel<?,?> getModel()

Get the model for this thingy.

Returns:

setModel

public void setModel(IShuttleModel<?,?> model)

Set the model to use for the shuttle. If the model changes or one of the component models has changed this will cause a redraw.

Parameters:

model -

modelChanged

public void modelChanged(@Nullable
                         ITableModel<Object> model)

The source model has changed. Rebuild the entire component.

Specified by:

modelChanged in interface ITableModelListener<Object>

See Also:

ITableModelListener.modelChanged(to.etc.domui.component.tbl.ITableModel)

rowAdded

public void rowAdded(@Nonnull
                     ITableModel<Object> model,
                     int index,
                     @Nonnull
                     Object value)
              throws Exception

A row was moved (back) to the source model: change it.

Specified by:

rowAdded in interface ITableModelListener<Object>

Throws:

Exception

See Also:

ITableModelListener.rowAdded(to.etc.domui.component.tbl.ITableModel, int, java.lang.Object)

rowDeleted

public void rowDeleted(@Nonnull
                       ITableModel<Object> model,
                       int index,
                       @Nonnull
                       Object value)
                throws Exception

Description copied from interface: ITableModelListener

Called after a row has been deleted.

Specified by:

rowDeleted in interface ITableModelListener<Object>

index - The index of the deleted row in the table.

value - The deleted value.

Throws:

Exception

rowModified

public void rowModified(@Nonnull
                        ITableModel<Object> model,
                        int index,
                        @Nonnull
                        Object value)
                 throws Exception

Description copied from interface: ITableModelListener

Called after a row has been changed.

Specified by:

rowModified in interface ITableModelListener<Object>

Throws:

Exception

getSourceRenderer

public INodeContentRenderer<Object> getSourceRenderer()

setSourceRenderer

public void setSourceRenderer(INodeContentRenderer<Object> sourceRenderer)

getTargetRenderer

public INodeContentRenderer<Object> getTargetRenderer()

setTargetRenderer

public void setTargetRenderer(INodeContentRenderer<Object> targetRenderer)

isOrderable

public boolean isOrderable()

Is this set to be orderable?

Returns:

getSourceRendererClass

public Class<? extends INodeContentRenderer<?>> getSourceRendererClass()

setSourceRendererClass

public void setSourceRendererClass(Class<? extends INodeContentRenderer<?>> sourceRendererClass)

getTargetRendererClass

public Class<? extends INodeContentRenderer<?>> getTargetRendererClass()

setTargetRendererClass

public void setTargetRendererClass(Class<? extends INodeContentRenderer<?>> targetRendererClass)

setOrderable

public void setOrderable(boolean orderable)

When set (and the model supports it) this shows ordering buttons at the right of the target shuttle, allowing the content to be moved up- and downwards.

Parameters:

orderable -