Package com.webmethods.caf.faces.component.tree

Class BaseTreeControl

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UIColumn

com.webmethods.caf.faces.component.table.BaseExtendedColumn

com.webmethods.caf.faces.component.table.html.HtmlTableColumn

com.webmethods.caf.faces.component.tree.BaseTreeControl

All Implemented Interfaces:

IDynamicComponent, IExtendedColumn, ITableRowStateHolder, Serializable, EventListener, PartialStateHolder, StateHolder, TransientStateHolder, ComponentSystemEventListener, FacesListener, SystemEventListenerHolder

public class BaseTreeControl
extends HtmlTableColumn

Tree-toggle control.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BaseTreeControl.DummyComponent	Add to dummy facet to capture decode() callback and propagate to column.
static class	BaseTreeControl.ToggleActionListener	Applies modifed open-state submitted value when an action event is recieved.

Field Summary

Fields

Modifier and Type	Field	Description
protected Collection<String>	m_submittedOpenIds
protected boolean	m_submittedUseUnopen
static final String	TYPE

Fields inherited from class com.webmethods.caf.faces.component.table.BaseExtendedColumn

NEGATIVE_ONE, ZERO

Fields inherited from class javax.faces.component.UIColumn

COMPONENT_FAMILY, COMPONENT_TYPE

Fields inherited from class javax.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Constructor Summary

Constructors

Constructor	Description
BaseTreeControl()

Method Summary

Modifier and Type	Method	Description
void	applySubmittedValues()	Applies the submitted values to this tree's open state.
String	getCollapseAllIcon()
String	getCollapseIcon()
String	getExpandAllIcon()
String	getExpandIcon()
String	getLeafIcon()
String	getLineBottomIcon()
String	getLineIcon()
String	getLineNoneIcon()
String	getLineTopIcon()
String	getLoadingIcon()
Collection<String>	getSubmittedOpenIds()
boolean	getSubmittedUseUnopen()
Object	getTableRowState()	Gets this control's per-row state.
boolean	isNowrap()	Override to change the default value
boolean	isShowSortLink()
void	restoreState(FacesContext context, Object state)	Override to workaround a NPE while restoring the system event listeners
void	setCollapseAllIcon(String collapseAllIcon)
void	setCollapseIcon(String collapseIcon)
void	setExpandAllIcon(String expandAllIcon)
void	setExpandIcon(String expandIcon)
void	setLeafIcon(String leafIcon)
void	setLineBottomIcon(String lineBottomIcon)
void	setLineIcon(String lineIcon)
void	setLineNoneIcon(String lineNoneIcon)
void	setLineTopIcon(String lineTopIcon)
void	setLoadingIcon(String loadingIcon)
void	setShowSortLink(boolean showSortLink)
void	setSubmittedOpenIds(Collection<String> ids)
void	setSubmittedUseUnopen(boolean useUnopen)
void	setTableRowState(Object o)	Sets this control's per-row state.

Methods inherited from class com.webmethods.caf.faces.component.table.html.HtmlTableColumn

populateInitialComponents

Methods inherited from class com.webmethods.caf.faces.component.table.BaseExtendedColumn

encodeFooter, encodeHeader, getAlign, getGroup, getLabel, getOrdinal, getPropertyOrBindingValue, getSecondaryEnd, getSecondaryStart, getSort, getValign, getWidth, isAscending, isExportable, isHidden, isOptional, isSecondary, setAlign, setAscending, setExportable, setGroup, setHidden, setLabel, setNowrap, setOptional, setOrdinal, setSecondary, setSecondaryEnd, setSecondaryStart, setSort, setValign, setWidth

Methods inherited from class javax.faces.component.UIColumn

getFamily, getFooter, getHeader, setFooter, setHeader

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree

Methods inherited from class java.lang.Object

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

Field Details

TYPE

public static final String TYPE

See Also:

• Constant Field Values

m_submittedUseUnopen

protected transient boolean m_submittedUseUnopen

m_submittedOpenIds

protected transient Collection<String> m_submittedOpenIds

Constructor Details

BaseTreeControl

public BaseTreeControl()

Method Details

restoreState

public void restoreState(FacesContext context,
 Object state)

Description copied from class: HtmlTableColumn

Override to workaround a NPE while restoring the system event listeners

Specified by:

restoreState in interface StateHolder

Overrides:

restoreState in class HtmlTableColumn

isNowrap

public boolean isNowrap()

Override to change the default value

Specified by:

isNowrap in interface IExtendedColumn

Overrides:

isNowrap in class BaseExtendedColumn

getTableRowState

public Object getTableRowState()

Gets this control's per-row state.

Specified by:

getTableRowState in interface ITableRowStateHolder

Overrides:

getTableRowState in class BaseExtendedColumn

setTableRowState

public void setTableRowState(Object o)

Sets this control's per-row state.

Specified by:

setTableRowState in interface ITableRowStateHolder

Overrides:

setTableRowState in class BaseExtendedColumn

applySubmittedValues

public void applySubmittedValues()

Applies the submitted values to this tree's open state.

getCollapseAllIcon

public String getCollapseAllIcon()

setCollapseAllIcon

public void setCollapseAllIcon(String collapseAllIcon)

getCollapseIcon

public String getCollapseIcon()

setCollapseIcon

public void setCollapseIcon(String collapseIcon)

getExpandAllIcon

public String getExpandAllIcon()

setExpandAllIcon

public void setExpandAllIcon(String expandAllIcon)

getExpandIcon

public String getExpandIcon()

setExpandIcon

public void setExpandIcon(String expandIcon)

getLoadingIcon

public String getLoadingIcon()

setLoadingIcon

public void setLoadingIcon(String loadingIcon)

getLeafIcon

public String getLeafIcon()

setLeafIcon

public void setLeafIcon(String leafIcon)

getLineBottomIcon

public String getLineBottomIcon()

setLineBottomIcon

public void setLineBottomIcon(String lineBottomIcon)

getLineIcon

public String getLineIcon()

setLineIcon

public void setLineIcon(String lineIcon)

getLineNoneIcon

public String getLineNoneIcon()

setLineNoneIcon

public void setLineNoneIcon(String lineNoneIcon)

getLineTopIcon

public String getLineTopIcon()

setLineTopIcon

public void setLineTopIcon(String lineTopIcon)

isShowSortLink

public boolean isShowSortLink()

setShowSortLink

public void setShowSortLink(boolean showSortLink)

getSubmittedUseUnopen

public boolean getSubmittedUseUnopen()

setSubmittedUseUnopen

public void setSubmittedUseUnopen(boolean useUnopen)

getSubmittedOpenIds

public Collection<String> getSubmittedOpenIds()

setSubmittedOpenIds

public void setSubmittedOpenIds(Collection<String> ids)