| com.sun.rave.web.ui.component.TemplateComponentBase
 com.sun.rave.web.ui.component.TreeNodeBase
All known Subclasses: com.sun.rave.web.ui.component.TreeNode,
| TreeNodeBase | | abstract public class TreeNodeBase extends com.sun.rave.web.ui.component.TemplateComponentBase (Code) | | 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!
|
| Method Summary | |
| public javax.faces.el.MethodBinding | getAction()
Specifies the action for the Hyperlink and
for the HyperlinkImage of this component. | | public javax.faces.el.MethodBinding | getActionListener()
| | public String | getFamily()
Return the identifier of the component family to which this
component belongs. | | public String | getImageURL()
Specifies imageURL for the ImageHyperlink
of this component. | | public String | getStyle()
| | public String | getStyleClass()
| | public String | getTarget()
Specifies the target for the Hyperlink and theImageHyperlink of this component. | | public String | getText()
Specifies the text for this component. | | public String | getToolTip()
| | public String | getUrl()
Specifies the url for the Hyperlink and theImageHyperlink for this component. | | public boolean | isExpanded()
| | public boolean | isVisible()
Use the visible attribute to indicate whether the component should be
viewable by the user in the rendered HTML page. | | public void | restoreState(FacesContext _context, Object _state)
| | public Object | saveState(FacesContext _context)
| | public void | setAction(javax.faces.el.MethodBinding action)
Specifies the action for the Hyperlink and
for the HyperlinkImage of this component. | | public void | setActionListener(javax.faces.el.MethodBinding actionListener)
| | public void | setExpanded(boolean expanded)
| | public void | setImageURL(String imageURL)
Specifies imageURL for the ImageHyperlink
of this component. | | public void | setStyle(String style)
| | public void | setStyleClass(String styleClass)
| | public void | setTarget(String target)
Specifies the target for the Hyperlink and theImageHyperlink of this component. | | public void | setText(String text)
Specifies the text for this component. | | public void | setToolTip(String toolTip)
| | public void | setUrl(String url)
Specifies the url for the Hyperlink and theImageHyperlink for this component. | | 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. |
| TreeNodeBase | | public TreeNodeBase()(Code) | | Construct a new TreeNodeBase.
|
| getAction | | public javax.faces.el.MethodBinding getAction()(Code) | | Specifies the action for the Hyperlink and
for the HyperlinkImage of this component. TheHyperlink 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.
|
| getActionListener | | public javax.faces.el.MethodBinding getActionListener()(Code) | | Method binding to a method that is invoked when this tree node is toggled
open or close
|
| getFamily | | public String getFamily()(Code) | | Return the identifier of the component family to which this
component belongs. This identifier, in conjunction with the value
of the rendererType property, may be used to select
the appropriate
Renderer for this component instance.
|
| getImageURL | | public String getImageURL()(Code) | | 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 utilizeTheme images. This property will not apply to the
facet when the facet used.
|
| getStyle | | public String getStyle()(Code) | | CSS style(s) to be applied when this component is rendered.
|
| getStyleClass | | public String getStyleClass()(Code) | | CSS style class(es) to be applied when this component is rendered.
|
| getTarget | | public String getTarget()(Code) | | Specifies the target for the Hyperlink and theImageHyperlink of this component. TheHyperlink 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.
|
| getText | | public String getText()(Code) | | Specifies the text for this component. If aurl or action is also specified, these
properties will be used to create a Hyperlink as the
content of this component. If neither theaction 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.
|
| getToolTip | | public String getToolTip()(Code) | | Display the text as a tooltip for this component
|
| getUrl | | public String getUrl()(Code) | | Specifies the url for the Hyperlink and theImageHyperlink for this component. TheHyperlink 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.
|
| isExpanded | | public boolean isExpanded()(Code) | | Specifies if this TreeNode will be expanded or collapsed,
in other words if its child TreeNodes should be
displayed.
|
| isVisible | | public boolean isVisible()(Code) | | 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.
|
| restoreState | | public void restoreState(FacesContext _context, Object _state)(Code) | | Restore the state of this component.
|
| saveState | | public Object saveState(FacesContext _context)(Code) | | Save the state of this component.
|
| setAction | | public void setAction(javax.faces.el.MethodBinding action)(Code) | | Specifies the action for the Hyperlink and
for the HyperlinkImage of this component. TheHyperlink 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: TreeNodeBase.getAction() |
| setActionListener | | public void setActionListener(javax.faces.el.MethodBinding actionListener)(Code) | | Method binding to a method that is invoked when this tree node is toggled
open or close
See Also: TreeNodeBase.getActionListener() |
| setExpanded | | public void setExpanded(boolean expanded)(Code) | | Specifies if this TreeNode will be expanded or collapsed,
in other words if its child TreeNodes should be
displayed.
See Also: TreeNodeBase.isExpanded() |
| setImageURL | | public void setImageURL(String imageURL)(Code) | | 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 utilizeTheme images. This property will not apply to the
facet when the facet used.
See Also: TreeNodeBase.getImageURL() |
| setTarget | | public void setTarget(String target)(Code) | | Specifies the target for the Hyperlink and theImageHyperlink of this component. TheHyperlink 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: TreeNodeBase.getTarget() |
| setText | | public void setText(String text)(Code) | | Specifies the text for this component. If aurl or action is also specified, these
properties will be used to create a Hyperlink as the
content of this component. If neither theaction 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: TreeNodeBase.getText() |
| setUrl | | public void setUrl(String url)(Code) | | Specifies the url for the Hyperlink and theImageHyperlink for this component. TheHyperlink 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: TreeNodeBase.getUrl() |
| setVisible | | public void setVisible(boolean visible)(Code) | | 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: TreeNodeBase.isVisible() |
|
|