com.github.bordertech.wcomponents.examples.picker

Class ExamplePickerTree

java.lang.Object

com.github.bordertech.wcomponents.AbstractWComponent

com.github.bordertech.wcomponents.WBeanComponent

com.github.bordertech.wcomponents.AbstractInput

com.github.bordertech.wcomponents.WTree

com.github.bordertech.wcomponents.examples.picker.ExamplePickerTree

All Implemented Interfaces:

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

public class ExamplePickerTree
extends WTree

WTree based example selection tool. For internal use only.

Since:

1.2.3

Author:

Mark Reeves

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ExamplePickerTree.ExampleMenuList The data object used by the WTree.
static class	ExamplePickerTree.MenuTreeModel The Model for this WTree.

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

WTree.ExpandMode, WTree.SelectMode, WTree.Type, WTree.WTreeComponentModel

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 and Description
ExamplePickerTree() Create the example selection tree.

Method Summary

Modifier and Type	Method and Description
void	addExamples(String groupName, ExampleData[] entries) Add a set of examples to the WTree.
ExampleData	getSelectedExampleData() Get the example which is selected in the tree.
ExamplePickerTree.MenuTreeModel	getTreeModel()
protected void	preparePaintComponent(Request request) Set the tree model on first use.

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

addPrevExpandedCurrent, afterPaint, beforeHandleRequest, checkExpandedCustomNodes, clearItemIdMaps, clearPrevExpandedRows, doHandleRequest, getAllItemIdIndexMap, getComponentModel, getCustomIdNodeMap, getCustomTree, getExpandedItemIdIndexMap, getExpandedRows, getExpandMode, getItemIdPrefix, getItemImageUrl, getMargin, getOpenAction, getOpenRequestItemId, getOrCreateComponentModel, getPrevExpandedRows, getRequestValue, getRowIndexForCustomItemId, getSelectedRows, getSelectMode, getShuffleAction, getTargetId, getType, getValue, getValueAsString, hasOpenRequest, initialiseComponentModel, isEmpty, isOpenItemRequest, isPresent, isShuffle, isShuffleRequest, newComponentModel, setCustomTree, setCustomTree, setExpandedRows, setExpandMode, setMargin, setOpenAction, setSelectedRows, setSelectMode, setShuffle, setShuffleAction, setTreeModel, setType, toString

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

addValidator, createMandatoryDiagnostic, doHandleChanged, getActionCommand, getActionObject, getActionOnChange, getDefaultSubmitButton, getDiagnostics, getValidators, handleRequest, isChangedInLastRequest, isCurrentAjaxTrigger, isDisabled, isMandatory, isReadOnly, setActionObject, setActionOnChange, setChangedInLastRequest, setDefaultSubmitButton, setDisabled, setMandatory, setMandatory, setReadOnly, showErrorIndicatorsForComponent, showIndicatorsForComponent, showWarningIndicatorsForComponent, 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, 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, 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, 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.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

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

getData, setData

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.BeanAware

getBean, getBeanProperty, getBeanValue, setBeanProperty

Constructor Detail

ExamplePickerTree

public ExamplePickerTree()

Create the example selection tree.

Method Detail

getTreeModel

public ExamplePickerTree.MenuTreeModel getTreeModel()

Overrides:

getTreeModel in class WTree

Returns:

The tree model for type safety.

addExamples

public void addExamples(String groupName,
                        ExampleData[] entries)

Add a set of examples to the WTree.

Parameters:

groupName - The name of the example group.

entries - An array of examples in this group.

getSelectedExampleData

public final ExampleData getSelectedExampleData()

Get the example which is selected in the tree.

Returns:

an example data object.

preparePaintComponent

protected void preparePaintComponent(Request request)

Set the tree model on first use.

Overrides:

preparePaintComponent in class WTree

Parameters:

request - The request.