Package com.github.bordertech.wcomponents

Class WShuffler

java.lang.Object

com.github.bordertech.wcomponents.AbstractWComponent

com.github.bordertech.wcomponents.WBeanComponent

com.github.bordertech.wcomponents.AbstractInput

com.github.bordertech.wcomponents.WShuffler

All Implemented Interfaces:

AjaxTarget, AjaxTrigger, BeanAware, BeanBound, BeanProviderBound, DataBound, Diagnosable, Disableable, Input, Labelable, Mandatable, SubordinateTarget, WComponent, WebComponent, Serializable

public class WShuffler
extends AbstractInput
implements AjaxTrigger, AjaxTarget, SubordinateTarget

The WShuffler is a WComponent that allows a list of options to have its order manually shuffled by the user. The component accepts a list of objects and the toString method is used to render the option in the response.

Since:

1.0.0

Author:

Jonathan Austin

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WShuffler.ShufflerModel	The ShufflerModel holds the state management of the shuffler.

Nested classes/interfaces inherited from class com.github.bordertech.wcomponents.AbstractInput

AbstractInput.InputModel

Nested classes/interfaces inherited from class com.github.bordertech.wcomponents.AbstractWComponent

AbstractWComponent.WComponentRef

Field Summary

Fields inherited from interface com.github.bordertech.wcomponents.WComponent

DEFAULT_APPLICATION_ID, DEFAULT_INTERNAL_ID, DEFAULT_NO_ID, ID_CONTEXT_SEPERATOR, ID_FRAMEWORK_ASSIGNED_SEPERATOR, ID_VALIDATION_PATTERN

Constructor Summary

Constructors

Constructor	Description
WShuffler()	Creates an empty WShuffler.
WShuffler(List<?> options)	Creates a WShuffler with the specified options.

Method Summary

Modifier and Type	Method	Description
protected boolean	doHandleRequest(Request request)	Specific handle request processing for an input component is provided here.
protected WShuffler.ShufflerModel	getComponentModel()	Returns the effective component model for this component.
List<?>	getOptions()	Retrieves the shuffler options.
protected WShuffler.ShufflerModel	getOrCreateComponentModel()	Retrieves the model for this component so that it can be modified.
List<?>	getRequestValue(Request request)	Provide the value of the component on the Request.
int	getRows()
List<?>	getValue()	Provide the value of the component returned by DataBound.getData() in the correct format.
protected boolean	isPresent(Request request)	Determine if this component is on the Request.
protected WShuffler.ShufflerModel	newComponentModel()	Creates a new model appropriate for this component.
void	setOptions(List<?> options)	Sets the shuffler options.
void	setRows(int rows)	Sets the maximum number of rows that are visible in the list at any one time.

Methods inherited from class com.github.bordertech.wcomponents.AbstractInput

addValidator, beforeHandleRequest, createMandatoryDiagnostic, doHandleChanged, getActionCommand, getActionObject, getActionOnChange, getDefaultSubmitButton, getDiagnostics, getValidators, getValueAsString, handleRequest, isChangedInLastRequest, isCurrentAjaxTrigger, isDisabled, isEmpty, isMandatory, isReadOnly, setActionObject, setActionOnChange, setChangedInLastRequest, setDefaultSubmitButton, setDisabled, setMandatory, setMandatory, setReadOnly, showErrorIndicatorsForComponent, showIndicatorsForComponent, showWarningIndicatorsForComponent, toString, validateComponent

Methods inherited from class com.github.bordertech.wcomponents.WBeanComponent

addBeanToScratchMap, doUpdateBeanValue, getBean, getBeanFromScratchMap, getBeanId, getBeanProperty, getBeanProvider, getBeanScratchMap, getBeanValue, getData, isBeanInScratchMap, isChanged, isSearchAncestors, isUseRequestScopeScratchMap, removeBeanFromScratchMap, resetData, setBean, setBeanId, setBeanProperty, setBeanProvider, setData, setSearchAncestors, updateBeanValue

Methods inherited from class com.github.bordertech.wcomponents.AbstractWComponent

addHtmlClass, addHtmlClass, addNotify, afterPaint, assertAddSupported, beforePaint, createErrorDiagnostic, createErrorDiagnostic, forward, getAccessibleText, getAttribute, getBaseUrl, getDefaultModel, getEnvironment, getHeaders, getHtmlClass, getHtmlClasses, getId, getIdName, getInternalId, getLabel, getName, getParent, getScratchMap, getTabIndex, getTag, getTemplate, getTemplateMarkUp, getToolTip, hasNoComponentModel, hasTabIndex, initialiseComponentModel, invokeLater, invokeLaters, isDebugStructure, isDefaultState, isFlagSet, isHidden, isInitialised, isLocked, isTracking, isTrackingEnabled, isValidate, isVisible, paint, paintComponent, preparePaint, preparePaintComponent, removeAttribute, removeComponentModel, removeHtmlClass, removeHtmlClass, removeNotify, replaceWComponent, reset, serviceRequest, setAccessibleText, setAttribute, setEnvironment, setFlag, setFocussed, setHidden, setHtmlClass, setHtmlClass, setIdName, setInitialised, setLocked, setTag, setToolTip, setTrackingEnabled, setValidate, setVisible, showErrorIndicators, showWarningIndicators, tidyUpUIContext, tidyUpUIContextForTree, validate, writeReplace

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.github.bordertech.wcomponents.BeanAware

getBean, getBeanProperty, getBeanValue, setBeanProperty

Methods inherited from interface com.github.bordertech.wcomponents.BeanBound

isSearchAncestors, setBean

Methods inherited from interface com.github.bordertech.wcomponents.BeanProviderBound

getBeanId, setBeanId, setBeanProvider

Methods inherited from interface com.github.bordertech.wcomponents.DataBound

getData, setData

Methods inherited from interface com.github.bordertech.wcomponents.WComponent

addHtmlClass, addHtmlClass, forward, getAccessibleText, getAttribute, getBaseUrl, getEnvironment, getHeaders, getHtmlClass, getHtmlClasses, getId, getIdName, getInternalId, getLabel, getName, getParent, getTabIndex, getTag, getToolTip, handleRequest, hasTabIndex, invokeLater, isDefaultState, isHidden, isInitialised, isLocked, isTracking, isTrackingEnabled, isValidate, isVisible, paint, preparePaint, removeAttribute, removeHtmlClass, removeHtmlClass, reset, serviceRequest, setAccessibleText, setAttribute, setEnvironment, setFocussed, setHtmlClass, setHtmlClass, setIdName, setInitialised, setLocked, setTag, setToolTip, setTrackingEnabled, setValidate, setVisible, showErrorIndicators, showWarningIndicators, tidyUpUIContextForTree, validate

Constructor Detail

WShuffler

public WShuffler()

Creates an empty WShuffler.

WShuffler

public WShuffler(List<?> options)

Creates a WShuffler with the specified options.

Parameters:

options - the shuffler options.

Method Detail

setOptions

public void setOptions(List<?> options)

Sets the shuffler options.

Parameters:

options - the shuffler options

getOptions

public List<?> getOptions()

Retrieves the shuffler options.

Returns:

the shuffler options

getValue

public List<?> getValue()

Provide the value of the component returned by DataBound.getData() in the correct format.

If required, this method can convert the data into the correct type and also do any validation before the value is used.

Specified by:

getValue in interface Input

Overrides:

getValue in class AbstractInput

Returns:

the value of the component returned by DataBound.getData() in the correct format.

setRows

public void setRows(int rows)

Sets the maximum number of rows that are visible in the list at any one time.

Parameters:

rows - the number of rows to display.

getRows

public int getRows()

Returns:

the number of rows to display in the list.

doHandleRequest

protected boolean doHandleRequest(Request request)

Specific handle request processing for an input component is provided here.

Input components are required to determine if the component has changed in the request, set the component data to the new value (if changed) and return the changed flag.

Specified by:

doHandleRequest in class AbstractInput

Parameters:

request - the request being responded to.

Returns:

true if the input component has changed, otherwise return false

getRequestValue

public List<?> getRequestValue(Request request)

Provide the value of the component on the Request.

If the component is not on the request, the components current value will be provided.

Specified by:

getRequestValue in interface Input

Parameters:

request - the request being responded to.

Returns:

the value of this component on the Request, or its current state if it is not on the request.

isPresent

protected boolean isPresent(Request request)

Determine if this component is on the Request.

Overrides:

isPresent in class AbstractInput

Parameters:

request - the request being responded to.

Returns:

true if this component is on the Request, otherwise return false.

newComponentModel

protected WShuffler.ShufflerModel newComponentModel()

Creates a new model appropriate for this component.

Overrides:

newComponentModel in class AbstractInput

Returns:

a new BeanAndProviderBoundComponentModel.

getComponentModel

protected WShuffler.ShufflerModel getComponentModel()

Returns the effective component model for this component. Subclass may override this method to narrow the return type to their specific model type.

Overrides:

getComponentModel in class AbstractInput

Returns:

the effective component model

getOrCreateComponentModel

protected WShuffler.ShufflerModel getOrCreateComponentModel()

Retrieves the model for this component so that it can be modified. If this method is called during request processing, and a session specific model does not yet exist, then a new model is created. Subclasses may override this method to narrow the return type to their specific model type.

Overrides:

getOrCreateComponentModel in class AbstractInput

Returns:

the model for this component