com.sun.rave.web.ui.component
Class TreeNodeBase

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          com.sun.rave.web.ui.component.TemplateComponentBase
              com.sun.rave.web.ui.component.TreeNodeBase

All Implemented Interfaces:

ChildManager, javax.faces.component.NamingContainer, javax.faces.component.StateHolder, TemplateComponent

Direct Known Subclasses:

TreeNode

public abstract class TreeNodeBase

extends TemplateComponentBase

HTML Elements and Layout

The TreeNode component is designed to be used as a child of a Tree or another TreeNode component. This allows TreeNodes to form a tree structure. When the tree structure is rendered, the TreeNode component represents a "node" in the tree. The TreeNode component is responsible for rendering:

• A row of the tree lines that connect to other tree nodes.
• An expand / collapse IconHyperlink if there is atleast 1 child TreeNode (this will show or hide its child TreeNode(s)).
• An optional ImageHyperlink that pertains to the content of the tree node.
• Text or a Hyperlink for the content of the TreeNode.

Portions of the TreeNode may be overriden using facets. The following facets are supported:

• image
  --
  Replaces the ImageHyperlink which pertains to the content of the TreeNode. When used properties that pertain to the ImageHyperlink will not have any effect.
• content
  --
  Replaces the static text/Hyperlink area. When used properties that pertain to this area will not have any effect.

Client Side Javascript Functions

None (although the Tree component does contain JavaScript functions).

Example:

For an example, please see the documentation for the Tree Tag.

Auto-generated component class. Do NOT modify; all changes will be lost!

Field Summary

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

TreeNodeBase()
Construct a new TreeNodeBase.

Method Summary

javax.faces.el.MethodBinding	getAction() Specifies the action for the Hyperlink and for the HyperlinkImage of this component.
javax.faces.el.MethodBinding	getActionListener() Method binding to a method that is invoked when this tree node is toggled open or close
java.lang.String	getFamily() Return the family for this component.
java.lang.String	getImageURL() Specifies imageURL for the ImageHyperlink of this component.
java.lang.String	getStyle() CSS style(s) to be applied when this component is rendered.
java.lang.String	getStyleClass() CSS style class(es) to be applied when this component is rendered.
java.lang.String	getTarget() Specifies the target for the Hyperlink and the ImageHyperlink of this component.
java.lang.String	getText() Specifies the text for this component.
java.lang.String	getToolTip() Display the text as a tooltip for this component
java.lang.String	getUrl() Specifies the url for the Hyperlink and the ImageHyperlink for this component.
boolean	isExpanded() Specifies if this TreeNode will be expanded or collapsed, in other words if its child TreeNodes should be displayed.
boolean	isVisible() Use the visible attribute to indicate whether the component should be viewable by the user in the rendered HTML page.
void	restoreState(javax.faces.context.FacesContext _context, java.lang.Object _state) Restore the state of this component.
java.lang.Object	saveState(javax.faces.context.FacesContext _context) Save the state of this component.
void	setAction(javax.faces.el.MethodBinding action) Specifies the action for the Hyperlink and for the HyperlinkImage of this component.
void	setActionListener(javax.faces.el.MethodBinding actionListener) Method binding to a method that is invoked when this tree node is toggled open or close
void	setExpanded(boolean expanded) Specifies if this TreeNode will be expanded or collapsed, in other words if its child TreeNodes should be displayed.
void	setImageURL(java.lang.String imageURL) Specifies imageURL for the ImageHyperlink of this component.
void	setStyle(java.lang.String style) CSS style(s) to be applied when this component is rendered.
void	setStyleClass(java.lang.String styleClass) CSS style class(es) to be applied when this component is rendered.
void	setTarget(java.lang.String target) Specifies the target for the Hyperlink and the ImageHyperlink of this component.
void	setText(java.lang.String text) Specifies the text for this component.
void	setToolTip(java.lang.String toolTip) Display the text as a tooltip for this component
void	setUrl(java.lang.String url) Specifies the url for the Hyperlink and the ImageHyperlink for this component.
void	setVisible(boolean visible) Use the visible attribute to indicate whether the component should be viewable by the user in the rendered HTML page.

Methods inherited from class com.sun.rave.web.ui.component.TemplateComponentBase

getChild, getChild, getLayoutDefinition, getLayoutDefinitionKey, setLayoutDefinitionKey

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods inherited from class java.lang.Object

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

Constructor Detail

TreeNodeBase

public TreeNodeBase()

Construct a new TreeNodeBase.

Method Detail

getFamily

public java.lang.String getFamily()

Return the family for this component.

getAction

public javax.faces.el.MethodBinding getAction()

Specifies the action for the Hyperlink and for the HyperlinkImage of this component. The Hyperlink may alternately be defined via the "content" facet, and the image via the "image" facet. See Hyperlink documentation for more information on how to use action.

This property will not apply to the facets when a facet is used.

setAction

public void setAction(javax.faces.el.MethodBinding action)

Specifies the action for the Hyperlink and for the HyperlinkImage of this component. The Hyperlink may alternately be defined via the "content" facet, and the image via the "image" facet. See Hyperlink documentation for more information on how to use action.

This property will not apply to the facets when a facet is used.

See Also:

getAction()

getActionListener

public javax.faces.el.MethodBinding getActionListener()

Method binding to a method that is invoked when this tree node is toggled open or close

setActionListener

public void setActionListener(javax.faces.el.MethodBinding actionListener)

Method binding to a method that is invoked when this tree node is toggled open or close

See Also:

getActionListener()

isExpanded

public boolean isExpanded()

Specifies if this TreeNode will be expanded or collapsed, in other words if its child TreeNodes should be displayed.

setExpanded

public void setExpanded(boolean expanded)

Specifies if this TreeNode will be expanded or collapsed, in other words if its child TreeNodes should be displayed.

See Also:

isExpanded()

getImageURL

public java.lang.String getImageURL()

Specifies imageURL for the ImageHyperlink of this component. The image may alternately be defined via the "image" facet. The "image" facet may be an IconHyperlink component to utilize Theme images.

This property will not apply to the facet when the facet used.

setImageURL

public void setImageURL(java.lang.String imageURL)

Specifies imageURL for the ImageHyperlink of this component. The image may alternately be defined via the "image" facet. The "image" facet may be an IconHyperlink component to utilize Theme images.

This property will not apply to the facet when the facet used.

See Also:

getImageURL()

getStyle

public java.lang.String getStyle()

CSS style(s) to be applied when this component is rendered.

setStyle

public void setStyle(java.lang.String style)

CSS style(s) to be applied when this component is rendered.

See Also:

getStyle()

getStyleClass

public java.lang.String getStyleClass()

CSS style class(es) to be applied when this component is rendered.

setStyleClass

public void setStyleClass(java.lang.String styleClass)

CSS style class(es) to be applied when this component is rendered.

See Also:

getStyleClass()

getTarget

public java.lang.String getTarget()

Specifies the target for the Hyperlink and the ImageHyperlink of this component. The Hyperlink may alternately be defined via the "content" facet of this tree node, and the image via the "image" facet.

This property will not apply to the facet when a facet is used.

setTarget

public void setTarget(java.lang.String target)

Specifies the target for the Hyperlink and the ImageHyperlink of this component. The Hyperlink may alternately be defined via the "content" facet of this tree node, and the image via the "image" facet.

This property will not apply to the facet when a facet is used.

See Also:

getTarget()

getText

public java.lang.String getText()

Specifies the text for this component. If a url or action is also specified, these properties will be used to create a Hyperlink as the content of this component. If neither the action or url properties are specified, this property will be used to display static text as the content for this component.

Alternately, the "content" facet may be used to specify the content for this component. If this facet is used, this property has no effect.

setText

public void setText(java.lang.String text)

Specifies the text for this component. If a url or action is also specified, these properties will be used to create a Hyperlink as the content of this component. If neither the action or url properties are specified, this property will be used to display static text as the content for this component.

Alternately, the "content" facet may be used to specify the content for this component. If this facet is used, this property has no effect.

See Also:

getText()

getToolTip

public java.lang.String getToolTip()

Display the text as a tooltip for this component

setToolTip

public void setToolTip(java.lang.String toolTip)

Display the text as a tooltip for this component

See Also:

getToolTip()

getUrl

public java.lang.String getUrl()

Specifies the url for the Hyperlink and the ImageHyperlink for this component. The Hyperlink may alternately be defined via the "content" facet, and the image via the "image" facet.

This property will not apply to the facet when a facet is used.

setUrl

public void setUrl(java.lang.String url)

Specifies the url for the Hyperlink and the ImageHyperlink for this component. The Hyperlink may alternately be defined via the "content" facet, and the image via the "image" facet.

This property will not apply to the facet when a facet is used.

See Also:

getUrl()

isVisible

public boolean isVisible()

Use the visible attribute to indicate whether the component should be viewable by the user in the rendered HTML page. If set to false, the HTML code for the component is present in the page, but the component is hidden with style attributes. By default, visible is set to true, so HTML for the component HTML is included and visible to the user. If the component is not visible, it can still be processed on subsequent form submissions because the HTML is present.

setVisible

public void setVisible(boolean visible)

Use the visible attribute to indicate whether the component should be viewable by the user in the rendered HTML page. If set to false, the HTML code for the component is present in the page, but the component is hidden with style attributes. By default, visible is set to true, so HTML for the component HTML is included and visible to the user. If the component is not visible, it can still be processed on subsequent form submissions because the HTML is present.

See Also:

isVisible()

restoreState

public void restoreState(javax.faces.context.FacesContext _context,
                         java.lang.Object _state)

Restore the state of this component.

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class TemplateComponentBase

Parameters:

_context - The FacesContext

_state - The serialized State

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext _context)

Save the state of this component.

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class TemplateComponentBase

Parameters:

_context - The FacesContext

Returns:

The serialized State