com.github.bordertech.wcomponents.examples.picker

Class SimplePicker

java.lang.Object

com.github.bordertech.wcomponents.AbstractWComponent

com.github.bordertech.wcomponents.WBeanComponent

com.github.bordertech.wcomponents.WContainer

com.github.bordertech.wcomponents.examples.picker.SimplePicker

All Implemented Interfaces:

BeanAware, BeanBound, BeanProviderBound, Container, DataBound, MessageContainer, MutableContainer, NamingContextable, WComponent, WebComponent, Serializable

public class SimplePicker
extends WContainer
implements MessageContainer

A component that enables you to pick an example to display.

Author:

Martin Shevchenko

See Also:

Serialized Form

Nested Class Summary

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 and Description
SimplePicker() Creates an SimplePicker.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	afterPaint(RenderContext renderContext) Override afterPaint in order to paint the UIContext serialization statistics if the profile button has been pressed.
void	displaySelection(String selection) Get the example picker to display the given selection.
void	displaySelection(WComponent selectedComponent) Get the example picker to display the given selected component.
Container	getCurrentComponent() Retrieves the component that is currently being displayed by the example picker.
WMessages	getMessages()
protected void	preparePaintComponent(Request request) When the example picker starts up, we want to display the last selection the user made in their previous session.

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

add, add, getChildAt, getChildCount, getChildren, getIndexOfChild, getNamingContextId, isNamingContext, remove, removeAll, setNamingContext, setTemplate, setTemplate, setTemplateMarkUp

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

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

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

addHtmlClass, addHtmlClass, addNotify, 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, handleRequest, hasNoComponentModel, hasTabIndex, initialiseComponentModel, invokeLater, invokeLaters, isDebugStructure, isDefaultState, isFlagSet, isHidden, isInitialised, isLocked, isTracking, isTrackingEnabled, isValidate, isVisible, paint, paintComponent, preparePaint, 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, showErrorIndicatorsForComponent, showWarningIndicators, showWarningIndicatorsForComponent, tidyUpUIContext, tidyUpUIContextForTree, toString, validate, validateComponent, 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.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

SimplePicker

public SimplePicker()

Creates an SimplePicker.

Method Detail

preparePaintComponent

protected void preparePaintComponent(Request request)

When the example picker starts up, we want to display the last selection the user made in their previous session. We can do this because the list of recent selections is stored in a file on the file system.

Overrides:

preparePaintComponent in class AbstractWComponent

Parameters:

request - the request being responded to.

afterPaint

protected void afterPaint(RenderContext renderContext)

Override afterPaint in order to paint the UIContext serialization statistics if the profile button has been pressed.

Overrides:

afterPaint in class AbstractWComponent

Parameters:

renderContext - the renderContext to send output to.

getMessages

public WMessages getMessages()

Specified by:

getMessages in interface MessageContainer

getCurrentComponent

public Container getCurrentComponent()

Retrieves the component that is currently being displayed by the example picker.

Returns:

the current example.

displaySelection

public void displaySelection(String selection)

Get the example picker to display the given selection.

Parameters:

selection - the class name of the wcomponent to be loaded and displayed.

displaySelection

public void displaySelection(WComponent selectedComponent)

Get the example picker to display the given selected component.

Parameters:

selectedComponent - the wcomponent to be displayed.