Added: myfaces/site/javadoc/org/apache/myfaces/custom/tree2/HtmlTree.html URL: http://svn.apache.org/viewcvs/myfaces/site/javadoc/org/apache/myfaces/custom/tree2/HtmlTree.html?rev=167885&view=auto ============================================================================== --- myfaces/site/javadoc/org/apache/myfaces/custom/tree2/HtmlTree.html (added) +++ myfaces/site/javadoc/org/apache/myfaces/custom/tree2/HtmlTree.html Tue May 3 02:06:41 2005 @@ -0,0 +1,590 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!--NewPage--> +<HTML> +<HEAD> +<!-- Generated by javadoc (build 1.4.2_05) on Tue May 03 10:59:38 CEST 2005 --> +<TITLE> +HtmlTree (Apache MyFaces API Documentation) +</TITLE> + +<META NAME="keywords" CONTENT="org.apache.myfaces.custom.tree2.HtmlTree class"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + parent.document.title="HtmlTree (Apache MyFaces API Documentation)"; +} +</SCRIPT> + +</HEAD> + +<BODY BGCOLOR="white" onload="windowTitle();"> + + +<!-- ========= START OF TOP NAVBAR ======= --> +<A NAME="navbar_top"><!-- --></A> +<A HREF="#skip-navbar_top" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_top_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + PREV CLASS + <A HREF="../../../../../org/apache/myfaces/custom/tree2/HtmlTreeRenderer.html" title="class in org.apache.myfaces.custom.tree2"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A> + <A HREF="HtmlTree.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_top"></A> +<!-- ========= END OF TOP NAVBAR ========= --> + +<HR> +<!-- ======== START OF CLASS DATA ======== --> +<H2> +<FONT SIZE="-1"> +org.apache.myfaces.custom.tree2</FONT> +<BR> +Class HtmlTree</H2> +<PRE> +java.lang.Object + <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by">javax.faces.component.UIComponent + <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by">javax.faces.component.UIComponentBase + <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../org/apache/myfaces/custom/tree2/UITreeData.html" title="class in org.apache.myfaces.custom.tree2">org.apache.myfaces.custom.tree2.UITreeData</A> + <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.myfaces.custom.tree2.HtmlTree</B> +</PRE> +<DL> +<DT><B>All Implemented Interfaces:</B> <DD>javax.faces.component.NamingContainer, javax.faces.component.StateHolder</DD> +</DL> +<HR> +<DL> +<DT>public class <B>HtmlTree</B><DT>extends <A HREF="../../../../../org/apache/myfaces/custom/tree2/UITreeData.html" title="class in org.apache.myfaces.custom.tree2">UITreeData</A></DL> + +<P> +Represents "tree data" in an HTML format. Also provides a mechanism for maintaining expand/collapse + state of the nodes in the tree. +<P> + +<P> +<DL> +<DT><B>Version:</B></DT> + <DD>$Revision: 167681 $ $Date: 2005-03-16 20:32:01 +0100 (Wed, 16 Mar 2005) $</DD> +<DT><B>Author:</B></DT> + <DD>Sean Schofield</DD> +</DL> +<HR> + +<P> +<!-- ======== NESTED CLASS SUMMARY ======== --> + + +<!-- =========== FIELD SUMMARY =========== --> + +<A NAME="field_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TD COLSPAN=2><FONT SIZE="+2"> +<B>Field Summary</B></FONT></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/myfaces/custom/tree2/HtmlTree.html#COMPONENT_TYPE">COMPONENT_TYPE</A></B></CODE> + +<BR> + </TD> +</TR> +</TABLE> + <A NAME="fields_inherited_from_class_org.apache.myfaces.custom.tree2.UITreeData"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TD><B>Fields inherited from class org.apache.myfaces.custom.tree2.<A HREF="../../../../../org/apache/myfaces/custom/tree2/UITreeData.html" title="class in org.apache.myfaces.custom.tree2">UITreeData</A></B></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><A HREF="../../../../../org/apache/myfaces/custom/tree2/UITreeData.html#COMPONENT_FAMILY">COMPONENT_FAMILY</A></CODE></TD> +</TR> +</TABLE> + <A NAME="fields_inherited_from_class_javax.faces.component.NamingContainer"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TD><B>Fields inherited from interface javax.faces.component.NamingContainer</B></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE>SEPARATOR_CHAR</CODE></TD> +</TR> +</TABLE> + +<!-- ======== CONSTRUCTOR SUMMARY ======== --> + +<A NAME="constructor_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TD COLSPAN=2><FONT SIZE="+2"> +<B>Constructor Summary</B></FONT></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../../../../org/apache/myfaces/custom/tree2/HtmlTree.html#HtmlTree()">HtmlTree</A></B>()</CODE> + +<BR> + Constructor</TD> +</TR> +</TABLE> + +<!-- ========== METHOD SUMMARY =========== --> + +<A NAME="method_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TD COLSPAN=2><FONT SIZE="+2"> +<B>Method Summary</B></FONT></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/myfaces/custom/tree2/HtmlTree.html#encodeBegin(javax.faces.context.FacesContext)">encodeBegin</A></B>(javax.faces.context.FacesContext context)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> javax.faces.component.UICommand</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/myfaces/custom/tree2/HtmlTree.html#getExpandControl()">getExpandControl</A></B>()</CODE> + +<BR> + Gets the expand/collapse control that can be used to handle expand/collapse nodes. </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/myfaces/custom/tree2/HtmlTree.html#isNodeExpanded()">isNodeExpanded</A></B>()</CODE> + +<BR> + Indicates whether or not the current <A HREF="../../../../../org/apache/myfaces/custom/tree2/TreeNode.html" title="interface in org.apache.myfaces.custom.tree2"><CODE>TreeNode</CODE></A> is expanded.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/myfaces/custom/tree2/HtmlTree.html#isNodeSelected()">isNodeSelected</A></B>()</CODE> + +<BR> + Indicates whether or not the current <A HREF="../../../../../org/apache/myfaces/custom/tree2/TreeNode.html" title="interface in org.apache.myfaces.custom.tree2"><CODE>TreeNode</CODE></A> is selected.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>protected void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/myfaces/custom/tree2/HtmlTree.html#processChildNodes(javax.faces.context.FacesContext, org.apache.myfaces.custom.tree2.TreeNode, int)">processChildNodes</A></B>(javax.faces.context.FacesContext context, + <A HREF="../../../../../org/apache/myfaces/custom/tree2/TreeNode.html" title="interface in org.apache.myfaces.custom.tree2">TreeNode</A> parentNode, + int processAction)</CODE> + +<BR> + Process the child nodes of the supplied parent @{link TreeNode}. </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/myfaces/custom/tree2/HtmlTree.html#processDecodes(javax.faces.context.FacesContext)">processDecodes</A></B>(javax.faces.context.FacesContext context)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/myfaces/custom/tree2/HtmlTree.html#restoreState(javax.faces.context.FacesContext, java.lang.Object)">restoreState</A></B>(javax.faces.context.FacesContext context, + java.lang.Object state)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.Object</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/myfaces/custom/tree2/HtmlTree.html#saveState(javax.faces.context.FacesContext)">saveState</A></B>(javax.faces.context.FacesContext context)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/myfaces/custom/tree2/HtmlTree.html#setNodeId(java.lang.String)">setNodeId</A></B>(java.lang.String nodeId)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/myfaces/custom/tree2/HtmlTree.html#setNodeSelected(javax.faces.event.ActionEvent)">setNodeSelected</A></B>(javax.faces.event.ActionEvent event)</CODE> + +<BR> + Implements the <CODE>ActionListener</CODE> interface. </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/myfaces/custom/tree2/HtmlTree.html#setVarNodeToggler(java.lang.String)">setVarNodeToggler</A></B>(java.lang.String varNodeToggler)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/myfaces/custom/tree2/HtmlTree.html#toggleExpanded()">toggleExpanded</A></B>()</CODE> + +<BR> + </TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_org.apache.myfaces.custom.tree2.UITreeData"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TD><B>Methods inherited from class org.apache.myfaces.custom.tree2.<A HREF="../../../../../org/apache/myfaces/custom/tree2/UITreeData.html" title="class in org.apache.myfaces.custom.tree2">UITreeData</A></B></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><A HREF="../../../../../org/apache/myfaces/custom/tree2/UITreeData.html#broadcast(javax.faces.event.FacesEvent)">broadcast</A>, <A HREF="../../../../../org/apache/myfaces/custom/tree2/UITreeData.html#getClientId(javax.faces.context.FacesContext)">getClientId</A>, <A HREF="../../../../../org/apache/myfaces/custom/tree2/UITreeData.html#getFamily()">getFamily</A>, <A HREF="../../../../../org/apache/myfaces/custom/tree2/UITreeData.html#getNode()">getNode</A>, <A HREF="../../../../../org/apache/myfaces/custom/tree2/UITreeData.html#getNodeId()">getNodeId</A>, <A HREF="../../../../../org/apache/myfaces/custom/tree2/UITreeData.html#getPathInformation(java.lang.String)">getPathInformation</A>, <A HREF="../../../../../org/apache/myfaces/custom/tree2/UITreeData.html#getValue()">getValue</A>, <A HREF="../../../../../org/apache/myfaces/custom/tree2/UITreeData.html#getVar()">getVar</A>, <A HREF="../../../../../org/apache/myfaces/custom/tree2/UITreeData.html#isLastChild(java.lang.String)">isLastChild</A>, <A HREF="../../../../../org/apache/myfaces/custom/tree2/UITreeData.html#processUpdates(javax.faces.context.FacesContext)">processUpdates</A>, <A HREF="../../../../../org/apache/myfaces/custom/tree2/UITreeData.html#processValidators(javax.faces.context.FacesContext)">processValidators</A>, <A HREF="../../../../../org/apache/myfaces/custom/tree2/UITreeData.html#queueEvent(javax.faces.event.FacesEvent)">queueEvent</A>, <A HREF="../../../../../org/apache/myfaces/custom/tree2/UITreeData.html#setValue(org.apache.myfaces.custom.tree2.TreeNode)">setValue</A>, <A HREF="../../../../../org/apache/myfaces/custom/tree2/UITreeData.html#setValueBinding(java.lang.String, javax.faces.el.ValueBinding)">setValueBinding</A>, <A HREF="../../../../../org/apache/myfaces/custom/tree2/UITreeData.html#setVar(java.lang.String)">setVar</A></CODE></TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_javax.faces.component.UIComponentBase"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TD><B>Methods inherited from class javax.faces.component.UIComponentBase</B></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE>addFacesListener, decode, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient</CODE></TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TD><B>Methods inherited from class java.lang.Object</B></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> +</TR> +</TABLE> + +<P> + +<!-- ============ FIELD DETAIL =========== --> + +<A NAME="field_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TD COLSPAN=1><FONT SIZE="+2"> +<B>Field Detail</B></FONT></TD> +</TR> +</TABLE> + +<A NAME="COMPONENT_TYPE"><!-- --></A><H3> +COMPONENT_TYPE</H3> +<PRE> +public static final java.lang.String <B>COMPONENT_TYPE</B></PRE> +<DL> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.myfaces.custom.tree2.HtmlTree.COMPONENT_TYPE">Constant Field Values</A></DL> +</DL> + +<!-- ========= CONSTRUCTOR DETAIL ======== --> + +<A NAME="constructor_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TD COLSPAN=1><FONT SIZE="+2"> +<B>Constructor Detail</B></FONT></TD> +</TR> +</TABLE> + +<A NAME="HtmlTree()"><!-- --></A><H3> +HtmlTree</H3> +<PRE> +public <B>HtmlTree</B>()</PRE> +<DL> +<DD>Constructor +<P> +</DL> + +<!-- ============ METHOD DETAIL ========== --> + +<A NAME="method_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TD COLSPAN=1><FONT SIZE="+2"> +<B>Method Detail</B></FONT></TD> +</TR> +</TABLE> + +<A NAME="saveState(javax.faces.context.FacesContext)"><!-- --></A><H3> +saveState</H3> +<PRE> +public java.lang.Object <B>saveState</B>(javax.faces.context.FacesContext context)</PRE> +<DL> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE>saveState</CODE> in interface <CODE>javax.faces.component.StateHolder</CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/myfaces/custom/tree2/UITreeData.html#saveState(javax.faces.context.FacesContext)">saveState</A></CODE> in class <CODE><A HREF="../../../../../org/apache/myfaces/custom/tree2/UITreeData.html" title="class in org.apache.myfaces.custom.tree2">UITreeData</A></CODE></DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="restoreState(javax.faces.context.FacesContext, java.lang.Object)"><!-- --></A><H3> +restoreState</H3> +<PRE> +public void <B>restoreState</B>(javax.faces.context.FacesContext context, + java.lang.Object state)</PRE> +<DL> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE>restoreState</CODE> in interface <CODE>javax.faces.component.StateHolder</CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/myfaces/custom/tree2/UITreeData.html#restoreState(javax.faces.context.FacesContext, java.lang.Object)">restoreState</A></CODE> in class <CODE><A HREF="../../../../../org/apache/myfaces/custom/tree2/UITreeData.html" title="class in org.apache.myfaces.custom.tree2">UITreeData</A></CODE></DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="setNodeId(java.lang.String)"><!-- --></A><H3> +setNodeId</H3> +<PRE> +public void <B>setNodeId</B>(java.lang.String nodeId)</PRE> +<DL> +<DD><DL> +<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/myfaces/custom/tree2/UITreeData.html#setNodeId(java.lang.String)">setNodeId</A></CODE> in class <CODE><A HREF="../../../../../org/apache/myfaces/custom/tree2/UITreeData.html" title="class in org.apache.myfaces.custom.tree2">UITreeData</A></CODE></DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="processDecodes(javax.faces.context.FacesContext)"><!-- --></A><H3> +processDecodes</H3> +<PRE> +public void <B>processDecodes</B>(javax.faces.context.FacesContext context)</PRE> +<DL> +<DD><DL> +<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/myfaces/custom/tree2/UITreeData.html#processDecodes(javax.faces.context.FacesContext)">processDecodes</A></CODE> in class <CODE><A HREF="../../../../../org/apache/myfaces/custom/tree2/UITreeData.html" title="class in org.apache.myfaces.custom.tree2">UITreeData</A></CODE></DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="encodeBegin(javax.faces.context.FacesContext)"><!-- --></A><H3> +encodeBegin</H3> +<PRE> +public void <B>encodeBegin</B>(javax.faces.context.FacesContext context) + throws java.io.IOException</PRE> +<DL> +<DD><DL> +<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/myfaces/custom/tree2/UITreeData.html#encodeBegin(javax.faces.context.FacesContext)">encodeBegin</A></CODE> in class <CODE><A HREF="../../../../../org/apache/myfaces/custom/tree2/UITreeData.html" title="class in org.apache.myfaces.custom.tree2">UITreeData</A></CODE></DL> +</DD> +<DD><DL> + +<DT><B>Throws:</B> +<DD><CODE>java.io.IOException</CODE></DL> +</DD> +</DL> +<HR> + +<A NAME="getExpandControl()"><!-- --></A><H3> +getExpandControl</H3> +<PRE> +public javax.faces.component.UICommand <B>getExpandControl</B>()</PRE> +<DL> +<DD>Gets the expand/collapse control that can be used to handle expand/collapse nodes. This is only used in server-side + mode. It allows the nagivation controls (if any) to be clickable as well as any commandLinks the user has set up in + their JSP. +<P> +<DD><DL> + +<DT><B>Returns:</B><DD>UICommand</DL> +</DD> +</DL> +<HR> + +<A NAME="setVarNodeToggler(java.lang.String)"><!-- --></A><H3> +setVarNodeToggler</H3> +<PRE> +public void <B>setVarNodeToggler</B>(java.lang.String varNodeToggler)</PRE> +<DL> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="toggleExpanded()"><!-- --></A><H3> +toggleExpanded</H3> +<PRE> +public java.lang.String <B>toggleExpanded</B>()</PRE> +<DL> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="isNodeExpanded()"><!-- --></A><H3> +isNodeExpanded</H3> +<PRE> +public boolean <B>isNodeExpanded</B>()</PRE> +<DL> +<DD>Indicates whether or not the current <A HREF="../../../../../org/apache/myfaces/custom/tree2/TreeNode.html" title="interface in org.apache.myfaces.custom.tree2"><CODE>TreeNode</CODE></A> is expanded. +<P> +<DD><DL> + +<DT><B>Returns:</B><DD>boolean</DL> +</DD> +</DL> +<HR> + +<A NAME="processChildNodes(javax.faces.context.FacesContext, org.apache.myfaces.custom.tree2.TreeNode, int)"><!-- --></A><H3> +processChildNodes</H3> +<PRE> +protected void <B>processChildNodes</B>(javax.faces.context.FacesContext context, + <A HREF="../../../../../org/apache/myfaces/custom/tree2/TreeNode.html" title="interface in org.apache.myfaces.custom.tree2">TreeNode</A> parentNode, + int processAction)</PRE> +<DL> +<DD><B>Description copied from class: <CODE><A HREF="../../../../../org/apache/myfaces/custom/tree2/UITreeData.html" title="class in org.apache.myfaces.custom.tree2">UITreeData</A></CODE></B></DD> +<DD>Process the child nodes of the supplied parent @{link TreeNode}. This method is protected so that + it can be overriden by a subclass that may want to control how child nodes are processed. +<P> +<DD><DL> +<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/myfaces/custom/tree2/UITreeData.html#processChildNodes(javax.faces.context.FacesContext, org.apache.myfaces.custom.tree2.TreeNode, int)">processChildNodes</A></CODE> in class <CODE><A HREF="../../../../../org/apache/myfaces/custom/tree2/UITreeData.html" title="class in org.apache.myfaces.custom.tree2">UITreeData</A></CODE></DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>context</CODE> - FacesContext<DD><CODE>parentNode</CODE> - The parent node whose children are to be processed<DD><CODE>processAction</CODE> - An <code>int</code> representing the type of action to process</DL> +</DD> +</DL> +<HR> + +<A NAME="setNodeSelected(javax.faces.event.ActionEvent)"><!-- --></A><H3> +setNodeSelected</H3> +<PRE> +public void <B>setNodeSelected</B>(javax.faces.event.ActionEvent event)</PRE> +<DL> +<DD>Implements the <CODE>ActionListener</CODE> interface. Basically, this method is used to listen for + node selection events (when a user has clicked on a leaf node.) +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>event</CODE> - ActionEvent</DL> +</DD> +</DL> +<HR> + +<A NAME="isNodeSelected()"><!-- --></A><H3> +isNodeSelected</H3> +<PRE> +public boolean <B>isNodeSelected</B>()</PRE> +<DL> +<DD>Indicates whether or not the current <A HREF="../../../../../org/apache/myfaces/custom/tree2/TreeNode.html" title="interface in org.apache.myfaces.custom.tree2"><CODE>TreeNode</CODE></A> is selected. +<P> +<DD><DL> + +<DT><B>Returns:</B><DD>boolean</DL> +</DD> +</DL> +<!-- ========= END OF CLASS DATA ========= --> +<HR> + + +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<A NAME="navbar_bottom"><!-- --></A> +<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_bottom_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + PREV CLASS + <A HREF="../../../../../org/apache/myfaces/custom/tree2/HtmlTreeRenderer.html" title="class in org.apache.myfaces.custom.tree2"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A> + <A HREF="HtmlTree.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_bottom"></A> +<!-- ======== END OF BOTTOM NAVBAR ======= --> + +<HR> + +</BODY> +</HTML>
Added: myfaces/site/javadoc/org/apache/myfaces/custom/tree2/HtmlTreeRenderer.html URL: http://svn.apache.org/viewcvs/myfaces/site/javadoc/org/apache/myfaces/custom/tree2/HtmlTreeRenderer.html?rev=167885&view=auto ============================================================================== --- myfaces/site/javadoc/org/apache/myfaces/custom/tree2/HtmlTreeRenderer.html (added) +++ myfaces/site/javadoc/org/apache/myfaces/custom/tree2/HtmlTreeRenderer.html Tue May 3 02:06:41 2005 @@ -0,0 +1,527 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!--NewPage--> +<HTML> +<HEAD> +<!-- Generated by javadoc (build 1.4.2_05) on Tue May 03 10:59:38 CEST 2005 --> +<TITLE> +HtmlTreeRenderer (Apache MyFaces API Documentation) +</TITLE> + +<META NAME="keywords" CONTENT="org.apache.myfaces.custom.tree2.HtmlTreeRenderer class"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + parent.document.title="HtmlTreeRenderer (Apache MyFaces API Documentation)"; +} +</SCRIPT> + +</HEAD> + +<BODY BGCOLOR="white" onload="windowTitle();"> + + +<!-- ========= START OF TOP NAVBAR ======= --> +<A NAME="navbar_top"><!-- --></A> +<A HREF="#skip-navbar_top" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_top_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../org/apache/myfaces/custom/tree2/HtmlTree.html" title="class in org.apache.myfaces.custom.tree2"><B>PREV CLASS</B></A> + <A HREF="../../../../../org/apache/myfaces/custom/tree2/TreeModel.html" title="class in org.apache.myfaces.custom.tree2"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A> + <A HREF="HtmlTreeRenderer.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_top"></A> +<!-- ========= END OF TOP NAVBAR ========= --> + +<HR> +<!-- ======== START OF CLASS DATA ======== --> +<H2> +<FONT SIZE="-1"> +org.apache.myfaces.custom.tree2</FONT> +<BR> +Class HtmlTreeRenderer</H2> +<PRE> +java.lang.Object + <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by">javax.faces.render.Renderer + <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.myfaces.custom.tree2.HtmlTreeRenderer</B> +</PRE> +<HR> +<DL> +<DT>public class <B>HtmlTreeRenderer</B><DT>extends javax.faces.render.Renderer</DL> + +<P> +<DL> +<DT><B>Version:</B></DT> + <DD>$Revision: 167790 $ $Date: 2005-04-19 14:12:47 +0200 (Tue, 19 Apr 2005) $</DD> +<DT><B>Author:</B></DT> + <DD>Sean Schofield, Chris Barlow, Hans Bergsten (Some code taken from an example in his O'Reilly JavaServer Faces book. Copied with permission)</DD> +</DL> +<HR> + +<P> +<!-- ======== NESTED CLASS SUMMARY ======== --> + + +<!-- =========== FIELD SUMMARY =========== --> + +<A NAME="field_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TD COLSPAN=2><FONT SIZE="+2"> +<B>Field Summary</B></FONT></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>protected static java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/myfaces/custom/tree2/HtmlTreeRenderer.html#ROOT_NODE_ID">ROOT_NODE_ID</A></B></CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>protected static java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/myfaces/custom/tree2/HtmlTreeRenderer.html#TOGGLE_SPAN">TOGGLE_SPAN</A></B></CODE> + +<BR> + </TD> +</TR> +</TABLE> + +<!-- ======== CONSTRUCTOR SUMMARY ======== --> + +<A NAME="constructor_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TD COLSPAN=2><FONT SIZE="+2"> +<B>Constructor Summary</B></FONT></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../../../../org/apache/myfaces/custom/tree2/HtmlTreeRenderer.html#HtmlTreeRenderer()">HtmlTreeRenderer</A></B>()</CODE> + +<BR> + </TD> +</TR> +</TABLE> + +<!-- ========== METHOD SUMMARY =========== --> + +<A NAME="method_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TD COLSPAN=2><FONT SIZE="+2"> +<B>Method Summary</B></FONT></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>protected void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/myfaces/custom/tree2/HtmlTreeRenderer.html#afterNodeEncode(javax.faces.context.FacesContext, javax.faces.context.ResponseWriter)">afterNodeEncode</A></B>(javax.faces.context.FacesContext context, + javax.faces.context.ResponseWriter out)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>protected void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/myfaces/custom/tree2/HtmlTreeRenderer.html#beforeNodeEncode(javax.faces.context.FacesContext, javax.faces.context.ResponseWriter, org.apache.myfaces.custom.tree2.HtmlTree)">beforeNodeEncode</A></B>(javax.faces.context.FacesContext context, + javax.faces.context.ResponseWriter out, + <A HREF="../../../../../org/apache/myfaces/custom/tree2/HtmlTree.html" title="class in org.apache.myfaces.custom.tree2">HtmlTree</A> tree)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/myfaces/custom/tree2/HtmlTreeRenderer.html#decode(javax.faces.context.FacesContext, javax.faces.component.UIComponent)">decode</A></B>(javax.faces.context.FacesContext context, + javax.faces.component.UIComponent component)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/myfaces/custom/tree2/HtmlTreeRenderer.html#encodeBegin(javax.faces.context.FacesContext, javax.faces.component.UIComponent)">encodeBegin</A></B>(javax.faces.context.FacesContext context, + javax.faces.component.UIComponent component)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/myfaces/custom/tree2/HtmlTreeRenderer.html#encodeChildren(javax.faces.context.FacesContext, javax.faces.component.UIComponent)">encodeChildren</A></B>(javax.faces.context.FacesContext context, + javax.faces.component.UIComponent component)</CODE> + +<BR> + Renders the whole tree. </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>protected void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/myfaces/custom/tree2/HtmlTreeRenderer.html#encodeCurrentNode(javax.faces.context.FacesContext, javax.faces.context.ResponseWriter, org.apache.myfaces.custom.tree2.HtmlTree)">encodeCurrentNode</A></B>(javax.faces.context.FacesContext context, + javax.faces.context.ResponseWriter out, + <A HREF="../../../../../org/apache/myfaces/custom/tree2/HtmlTree.html" title="class in org.apache.myfaces.custom.tree2">HtmlTree</A> tree)</CODE> + +<BR> + Encodes the current node. </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>protected void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/myfaces/custom/tree2/HtmlTreeRenderer.html#encodeTree(javax.faces.context.FacesContext, javax.faces.context.ResponseWriter, org.apache.myfaces.custom.tree2.HtmlTree, java.lang.String, int)">encodeTree</A></B>(javax.faces.context.FacesContext context, + javax.faces.context.ResponseWriter out, + <A HREF="../../../../../org/apache/myfaces/custom/tree2/HtmlTree.html" title="class in org.apache.myfaces.custom.tree2">HtmlTree</A> tree, + java.lang.String parentId, + int childCount)</CODE> + +<BR> + Encodes the tree and its children.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>protected boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/myfaces/custom/tree2/HtmlTreeRenderer.html#getBoolean(javax.faces.component.UIComponent, java.lang.String, boolean)">getBoolean</A></B>(javax.faces.component.UIComponent component, + java.lang.String attributeName, + boolean defaultValue)</CODE> + +<BR> + Helper method for getting the boolean value of an attribute. </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/myfaces/custom/tree2/HtmlTreeRenderer.html#getRendersChildren()">getRendersChildren</A></B>()</CODE> + +<BR> + </TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_javax.faces.render.Renderer"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TD><B>Methods inherited from class javax.faces.render.Renderer</B></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE>convertClientId, encodeEnd, getConvertedValue</CODE></TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TD><B>Methods inherited from class java.lang.Object</B></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> +</TR> +</TABLE> + +<P> + +<!-- ============ FIELD DETAIL =========== --> + +<A NAME="field_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TD COLSPAN=1><FONT SIZE="+2"> +<B>Field Detail</B></FONT></TD> +</TR> +</TABLE> + +<A NAME="TOGGLE_SPAN"><!-- --></A><H3> +TOGGLE_SPAN</H3> +<PRE> +protected static final java.lang.String <B>TOGGLE_SPAN</B></PRE> +<DL> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.myfaces.custom.tree2.HtmlTreeRenderer.TOGGLE_SPAN">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="ROOT_NODE_ID"><!-- --></A><H3> +ROOT_NODE_ID</H3> +<PRE> +protected static final java.lang.String <B>ROOT_NODE_ID</B></PRE> +<DL> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.myfaces.custom.tree2.HtmlTreeRenderer.ROOT_NODE_ID">Constant Field Values</A></DL> +</DL> + +<!-- ========= CONSTRUCTOR DETAIL ======== --> + +<A NAME="constructor_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TD COLSPAN=1><FONT SIZE="+2"> +<B>Constructor Detail</B></FONT></TD> +</TR> +</TABLE> + +<A NAME="HtmlTreeRenderer()"><!-- --></A><H3> +HtmlTreeRenderer</H3> +<PRE> +public <B>HtmlTreeRenderer</B>()</PRE> +<DL> +</DL> + +<!-- ============ METHOD DETAIL ========== --> + +<A NAME="method_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TD COLSPAN=1><FONT SIZE="+2"> +<B>Method Detail</B></FONT></TD> +</TR> +</TABLE> + +<A NAME="getRendersChildren()"><!-- --></A><H3> +getRendersChildren</H3> +<PRE> +public boolean <B>getRendersChildren</B>()</PRE> +<DL> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="decode(javax.faces.context.FacesContext, javax.faces.component.UIComponent)"><!-- --></A><H3> +decode</H3> +<PRE> +public void <B>decode</B>(javax.faces.context.FacesContext context, + javax.faces.component.UIComponent component)</PRE> +<DL> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="encodeBegin(javax.faces.context.FacesContext, javax.faces.component.UIComponent)"><!-- --></A><H3> +encodeBegin</H3> +<PRE> +public void <B>encodeBegin</B>(javax.faces.context.FacesContext context, + javax.faces.component.UIComponent component) + throws java.io.IOException</PRE> +<DL> +<DD><DL> + +<DT><B>Throws:</B> +<DD><CODE>java.io.IOException</CODE></DL> +</DD> +</DL> +<HR> + +<A NAME="encodeChildren(javax.faces.context.FacesContext, javax.faces.component.UIComponent)"><!-- --></A><H3> +encodeChildren</H3> +<PRE> +public void <B>encodeChildren</B>(javax.faces.context.FacesContext context, + javax.faces.component.UIComponent component) + throws java.io.IOException</PRE> +<DL> +<DD>Renders the whole tree. It generates a <code><span></code> element with an <code>id</code> + attribute if the component has been given an explicit ID. The model nodes are rendered + recursively by the private <code>encodeNodes</code> method. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>context</CODE> - FacesContext<DD><CODE>component</CODE> - The component whose children are to be rendered +<DT><B>Throws:</B> +<DD><CODE>java.io.IOException</CODE></DL> +</DD> +</DL> +<HR> + +<A NAME="encodeTree(javax.faces.context.FacesContext, javax.faces.context.ResponseWriter, org.apache.myfaces.custom.tree2.HtmlTree, java.lang.String, int)"><!-- --></A><H3> +encodeTree</H3> +<PRE> +protected void <B>encodeTree</B>(javax.faces.context.FacesContext context, + javax.faces.context.ResponseWriter out, + <A HREF="../../../../../org/apache/myfaces/custom/tree2/HtmlTree.html" title="class in org.apache.myfaces.custom.tree2">HtmlTree</A> tree, + java.lang.String parentId, + int childCount) + throws java.io.IOException</PRE> +<DL> +<DD>Encodes the tree and its children. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>context</CODE> - FacesContext<DD><CODE>out</CODE> - ResponseWriter<DD><CODE>tree</CODE> - HtmlTree<DD><CODE>parentId</CODE> - The parent's node id (where parent is the parent of the node we are about to render.)<DD><CODE>childCount</CODE> - If this node is a child of another node, the count indicates which child number it is + (used to construct the id of the next node to render.) +<DT><B>Throws:</B> +<DD><CODE>java.io.IOException</CODE></DL> +</DD> +</DL> +<HR> + +<A NAME="encodeCurrentNode(javax.faces.context.FacesContext, javax.faces.context.ResponseWriter, org.apache.myfaces.custom.tree2.HtmlTree)"><!-- --></A><H3> +encodeCurrentNode</H3> +<PRE> +protected void <B>encodeCurrentNode</B>(javax.faces.context.FacesContext context, + javax.faces.context.ResponseWriter out, + <A HREF="../../../../../org/apache/myfaces/custom/tree2/HtmlTree.html" title="class in org.apache.myfaces.custom.tree2">HtmlTree</A> tree) + throws java.io.IOException</PRE> +<DL> +<DD>Encodes the current node. It is protected so that custom <CODE>Renderer</CODE>s can extend it. That might be useful + if you would like to render additional per node information besides the tree node. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>context</CODE> - FacesContext<DD><CODE>out</CODE> - ResponseWriter<DD><CODE>tree</CODE> - HtmlTree +<DT><B>Throws:</B> +<DD><CODE>java.io.IOException</CODE></DL> +</DD> +</DL> +<HR> + +<A NAME="beforeNodeEncode(javax.faces.context.FacesContext, javax.faces.context.ResponseWriter, org.apache.myfaces.custom.tree2.HtmlTree)"><!-- --></A><H3> +beforeNodeEncode</H3> +<PRE> +protected void <B>beforeNodeEncode</B>(javax.faces.context.FacesContext context, + javax.faces.context.ResponseWriter out, + <A HREF="../../../../../org/apache/myfaces/custom/tree2/HtmlTree.html" title="class in org.apache.myfaces.custom.tree2">HtmlTree</A> tree) + throws java.io.IOException</PRE> +<DL> +<DD><DL> + +<DT><B>Throws:</B> +<DD><CODE>java.io.IOException</CODE></DL> +</DD> +</DL> +<HR> + +<A NAME="afterNodeEncode(javax.faces.context.FacesContext, javax.faces.context.ResponseWriter)"><!-- --></A><H3> +afterNodeEncode</H3> +<PRE> +protected void <B>afterNodeEncode</B>(javax.faces.context.FacesContext context, + javax.faces.context.ResponseWriter out) + throws java.io.IOException</PRE> +<DL> +<DD><DL> + +<DT><B>Throws:</B> +<DD><CODE>java.io.IOException</CODE></DL> +</DD> +</DL> +<HR> + +<A NAME="getBoolean(javax.faces.component.UIComponent, java.lang.String, boolean)"><!-- --></A><H3> +getBoolean</H3> +<PRE> +protected boolean <B>getBoolean</B>(javax.faces.component.UIComponent component, + java.lang.String attributeName, + boolean defaultValue)</PRE> +<DL> +<DD>Helper method for getting the boolean value of an attribute. If the attribute is not specified, + then return the default value. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>component</CODE> - The component for which the attributes are to be checked.<DD><CODE>attributeName</CODE> - The name of the boolean attribute.<DD><CODE>defaultValue</CODE> - The default value of the attribute (to be returned if no value found). +<DT><B>Returns:</B><DD>boolean</DL> +</DD> +</DL> +<!-- ========= END OF CLASS DATA ========= --> +<HR> + + +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<A NAME="navbar_bottom"><!-- --></A> +<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_bottom_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../org/apache/myfaces/custom/tree2/HtmlTree.html" title="class in org.apache.myfaces.custom.tree2"><B>PREV CLASS</B></A> + <A HREF="../../../../../org/apache/myfaces/custom/tree2/TreeModel.html" title="class in org.apache.myfaces.custom.tree2"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A> + <A HREF="HtmlTreeRenderer.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_bottom"></A> +<!-- ======== END OF BOTTOM NAVBAR ======= --> + +<HR> + +</BODY> +</HTML> Added: myfaces/site/javadoc/org/apache/myfaces/custom/tree2/TreeModel.html URL: http://svn.apache.org/viewcvs/myfaces/site/javadoc/org/apache/myfaces/custom/tree2/TreeModel.html?rev=167885&view=auto ============================================================================== --- myfaces/site/javadoc/org/apache/myfaces/custom/tree2/TreeModel.html (added) +++ myfaces/site/javadoc/org/apache/myfaces/custom/tree2/TreeModel.html Tue May 3 02:06:41 2005 @@ -0,0 +1,340 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!--NewPage--> +<HTML> +<HEAD> +<!-- Generated by javadoc (build 1.4.2_05) on Tue May 03 10:59:38 CEST 2005 --> +<TITLE> +TreeModel (Apache MyFaces API Documentation) +</TITLE> + +<META NAME="keywords" CONTENT="org.apache.myfaces.custom.tree2.TreeModel class"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + parent.document.title="TreeModel (Apache MyFaces API Documentation)"; +} +</SCRIPT> + +</HEAD> + +<BODY BGCOLOR="white" onload="windowTitle();"> + + +<!-- ========= START OF TOP NAVBAR ======= --> +<A NAME="navbar_top"><!-- --></A> +<A HREF="#skip-navbar_top" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_top_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../org/apache/myfaces/custom/tree2/HtmlTreeRenderer.html" title="class in org.apache.myfaces.custom.tree2"><B>PREV CLASS</B></A> + <A HREF="../../../../../org/apache/myfaces/custom/tree2/TreeNodeBase.html" title="class in org.apache.myfaces.custom.tree2"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A> + <A HREF="TreeModel.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_top"></A> +<!-- ========= END OF TOP NAVBAR ========= --> + +<HR> +<!-- ======== START OF CLASS DATA ======== --> +<H2> +<FONT SIZE="-1"> +org.apache.myfaces.custom.tree2</FONT> +<BR> +Class TreeModel</H2> +<PRE> +java.lang.Object + <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.myfaces.custom.tree2.TreeModel</B> +</PRE> +<HR> +<DL> +<DT>public class <B>TreeModel</B><DT>extends java.lang.Object</DL> + +<P> +Model class for the tree component. It provides random access to nodes in a tree + made up of instances of the <A HREF="../../../../../org/apache/myfaces/custom/tree2/TreeNode.html" title="interface in org.apache.myfaces.custom.tree2"><CODE>TreeNode</CODE></A> class. +<P> + +<P> +<DL> +<DT><B>Version:</B></DT> + <DD>$Revision: 167610 $ $Date: 2005-02-19 10:03:02 +0100 (Sat, 19 Feb 2005) $</DD> +<DT><B>Author:</B></DT> + <DD>Sean Schofield, Hans Bergsten (Some code taken from an example in his O'Reilly JavaServer Faces book. Copied with permission)</DD> +</DL> +<HR> + +<P> +<!-- ======== NESTED CLASS SUMMARY ======== --> + + +<!-- =========== FIELD SUMMARY =========== --> + + +<!-- ======== CONSTRUCTOR SUMMARY ======== --> + +<A NAME="constructor_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TD COLSPAN=2><FONT SIZE="+2"> +<B>Constructor Summary</B></FONT></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../../../../org/apache/myfaces/custom/tree2/TreeModel.html#TreeModel(org.apache.myfaces.custom.tree2.TreeNode)">TreeModel</A></B>(<A HREF="../../../../../org/apache/myfaces/custom/tree2/TreeNode.html" title="interface in org.apache.myfaces.custom.tree2">TreeNode</A> root)</CODE> + +<BR> + Constructor</TD> +</TR> +</TABLE> + +<!-- ========== METHOD SUMMARY =========== --> + +<A NAME="method_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TD COLSPAN=2><FONT SIZE="+2"> +<B>Method Summary</B></FONT></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../../../../org/apache/myfaces/custom/tree2/TreeNode.html" title="interface in org.apache.myfaces.custom.tree2">TreeNode</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/myfaces/custom/tree2/TreeModel.html#getNode()">getNode</A></B>()</CODE> + +<BR> + Gets the current <A HREF="../../../../../org/apache/myfaces/custom/tree2/TreeNode.html" title="interface in org.apache.myfaces.custom.tree2"><CODE>TreeNode</CODE></A> or <code>null</code> if no node ID is selected.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.String[]</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/myfaces/custom/tree2/TreeModel.html#getPathInformation(java.lang.String)">getPathInformation</A></B>(java.lang.String nodeId)</CODE> + +<BR> + Gets an array of String containing the ID's of all of the <A HREF="../../../../../org/apache/myfaces/custom/tree2/TreeNode.html" title="interface in org.apache.myfaces.custom.tree2"><CODE>TreeNode</CODE></A>s in the path to + the specified node. </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/myfaces/custom/tree2/TreeModel.html#isLastChild(java.lang.String)">isLastChild</A></B>(java.lang.String nodeId)</CODE> + +<BR> + Indicates whether or not the specified <A HREF="../../../../../org/apache/myfaces/custom/tree2/TreeNode.html" title="interface in org.apache.myfaces.custom.tree2"><CODE>TreeNode</CODE></A> is the last child in the <code>List</code> + of children. </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/myfaces/custom/tree2/TreeModel.html#setNodeId(java.lang.String)">setNodeId</A></B>(java.lang.String nodeId)</CODE> + +<BR> + Sets the current <A HREF="../../../../../org/apache/myfaces/custom/tree2/TreeNode.html" title="interface in org.apache.myfaces.custom.tree2"><CODE>TreeNode</CODE></A> to the specified node ID, which is a colon-separated list + of node indexes. </TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TD><B>Methods inherited from class java.lang.Object</B></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> +</TR> +</TABLE> + +<P> + +<!-- ============ FIELD DETAIL =========== --> + + +<!-- ========= CONSTRUCTOR DETAIL ======== --> + +<A NAME="constructor_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TD COLSPAN=1><FONT SIZE="+2"> +<B>Constructor Detail</B></FONT></TD> +</TR> +</TABLE> + +<A NAME="TreeModel(org.apache.myfaces.custom.tree2.TreeNode)"><!-- --></A><H3> +TreeModel</H3> +<PRE> +public <B>TreeModel</B>(<A HREF="../../../../../org/apache/myfaces/custom/tree2/TreeNode.html" title="interface in org.apache.myfaces.custom.tree2">TreeNode</A> root)</PRE> +<DL> +<DD>Constructor +<P> +<DT><B>Parameters:</B><DD><CODE>root</CODE> - The root TreeNode</DL> + +<!-- ============ METHOD DETAIL ========== --> + +<A NAME="method_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TD COLSPAN=1><FONT SIZE="+2"> +<B>Method Detail</B></FONT></TD> +</TR> +</TABLE> + +<A NAME="getNode()"><!-- --></A><H3> +getNode</H3> +<PRE> +public <A HREF="../../../../../org/apache/myfaces/custom/tree2/TreeNode.html" title="interface in org.apache.myfaces.custom.tree2">TreeNode</A> <B>getNode</B>()</PRE> +<DL> +<DD>Gets the current <A HREF="../../../../../org/apache/myfaces/custom/tree2/TreeNode.html" title="interface in org.apache.myfaces.custom.tree2"><CODE>TreeNode</CODE></A> or <code>null</code> if no node ID is selected. +<P> +<DD><DL> + +<DT><B>Returns:</B><DD>The current node</DL> +</DD> +</DL> +<HR> + +<A NAME="setNodeId(java.lang.String)"><!-- --></A><H3> +setNodeId</H3> +<PRE> +public void <B>setNodeId</B>(java.lang.String nodeId)</PRE> +<DL> +<DD>Sets the current <A HREF="../../../../../org/apache/myfaces/custom/tree2/TreeNode.html" title="interface in org.apache.myfaces.custom.tree2"><CODE>TreeNode</CODE></A> to the specified node ID, which is a colon-separated list + of node indexes. For instance, "0:0:1" means "the second child node of the first child node + under the root node." +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>nodeId</CODE> - The id of the node to set</DL> +</DD> +</DL> +<HR> + +<A NAME="getPathInformation(java.lang.String)"><!-- --></A><H3> +getPathInformation</H3> +<PRE> +public java.lang.String[] <B>getPathInformation</B>(java.lang.String nodeId)</PRE> +<DL> +<DD>Gets an array of String containing the ID's of all of the <A HREF="../../../../../org/apache/myfaces/custom/tree2/TreeNode.html" title="interface in org.apache.myfaces.custom.tree2"><CODE>TreeNode</CODE></A>s in the path to + the specified node. The path information will be an array of <code>String</code> objects + representing node ID's. The array will starting with the ID of the root node and end with + the ID of the specified node. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>nodeId</CODE> - The id of the node for whom the path information is needed. +<DT><B>Returns:</B><DD>String[]</DL> +</DD> +</DL> +<HR> + +<A NAME="isLastChild(java.lang.String)"><!-- --></A><H3> +isLastChild</H3> +<PRE> +public boolean <B>isLastChild</B>(java.lang.String nodeId)</PRE> +<DL> +<DD>Indicates whether or not the specified <A HREF="../../../../../org/apache/myfaces/custom/tree2/TreeNode.html" title="interface in org.apache.myfaces.custom.tree2"><CODE>TreeNode</CODE></A> is the last child in the <code>List</code> + of children. If the node id provided corresponds to the root node, this returns <code>true</code>. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>nodeId</CODE> - The ID of the node to check +<DT><B>Returns:</B><DD>boolean</DL> +</DD> +</DL> +<!-- ========= END OF CLASS DATA ========= --> +<HR> + + +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<A NAME="navbar_bottom"><!-- --></A> +<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_bottom_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../org/apache/myfaces/custom/tree2/HtmlTreeRenderer.html" title="class in org.apache.myfaces.custom.tree2"><B>PREV CLASS</B></A> + <A HREF="../../../../../org/apache/myfaces/custom/tree2/TreeNodeBase.html" title="class in org.apache.myfaces.custom.tree2"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A> + <A HREF="TreeModel.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_bottom"></A> +<!-- ======== END OF BOTTOM NAVBAR ======= --> + +<HR> + +</BODY> +</HTML> Added: myfaces/site/javadoc/org/apache/myfaces/custom/tree2/TreeNode.html URL: http://svn.apache.org/viewcvs/myfaces/site/javadoc/org/apache/myfaces/custom/tree2/TreeNode.html?rev=167885&view=auto ============================================================================== --- myfaces/site/javadoc/org/apache/myfaces/custom/tree2/TreeNode.html (added) +++ myfaces/site/javadoc/org/apache/myfaces/custom/tree2/TreeNode.html Tue May 3 02:06:41 2005 @@ -0,0 +1,441 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!--NewPage--> +<HTML> +<HEAD> +<!-- Generated by javadoc (build 1.4.2_05) on Tue May 03 10:59:38 CEST 2005 --> +<TITLE> +TreeNode (Apache MyFaces API Documentation) +</TITLE> + +<META NAME="keywords" CONTENT="org.apache.myfaces.custom.tree2.TreeNode interface"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + parent.document.title="TreeNode (Apache MyFaces API Documentation)"; +} +</SCRIPT> + +</HEAD> + +<BODY BGCOLOR="white" onload="windowTitle();"> + + +<!-- ========= START OF TOP NAVBAR ======= --> +<A NAME="navbar_top"><!-- --></A> +<A HREF="#skip-navbar_top" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_top_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + PREV CLASS + NEXT CLASS</FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A> + <A HREF="TreeNode.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_top"></A> +<!-- ========= END OF TOP NAVBAR ========= --> + +<HR> +<!-- ======== START OF CLASS DATA ======== --> +<H2> +<FONT SIZE="-1"> +org.apache.myfaces.custom.tree2</FONT> +<BR> +Interface TreeNode</H2> +<DL> +<DT><B>All Superinterfaces:</B> <DD>java.io.Serializable</DD> +</DL> +<DL> +<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../org/apache/myfaces/custom/tree2/TreeNodeBase.html" title="class in org.apache.myfaces.custom.tree2">TreeNodeBase</A></DD> +</DL> +<HR> +<DL> +<DT>public interface <B>TreeNode</B><DT>extends java.io.Serializable</DL> + +<P> +Defines the requirements for an object that can be used as a tree node for + use in a <A HREF="../../../../../org/apache/myfaces/custom/tree2/UITreeData.html" title="class in org.apache.myfaces.custom.tree2"><CODE>UITreeData</CODE></A> component. (inspired by javax.swing.tree.TreeNode). +<P> + +<P> +<DL> +<DT><B>Version:</B></DT> + <DD>$Revision: 167681 $ $Date: 2005-03-16 20:32:01 +0100 (Wed, 16 Mar 2005) $</DD> +<DT><B>Author:</B></DT> + <DD>Sean Schofield</DD> +</DL> +<HR> + +<P> +<!-- ======== NESTED CLASS SUMMARY ======== --> + + +<!-- =========== FIELD SUMMARY =========== --> + + +<!-- ======== CONSTRUCTOR SUMMARY ======== --> + + +<!-- ========== METHOD SUMMARY =========== --> + +<A NAME="method_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TD COLSPAN=2><FONT SIZE="+2"> +<B>Method Summary</B></FONT></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> int</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/myfaces/custom/tree2/TreeNode.html#getChildCount()">getChildCount</A></B>()</CODE> + +<BR> + Gets the number of children this node has.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.util.List</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/myfaces/custom/tree2/TreeNode.html#getChildren()">getChildren</A></B>()</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/myfaces/custom/tree2/TreeNode.html#getDescription()">getDescription</A></B>()</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/myfaces/custom/tree2/TreeNode.html#getIdentifier()">getIdentifier</A></B>()</CODE> + +<BR> + Gets the identifier asociated with the <A HREF="../../../../../org/apache/myfaces/custom/tree2/TreeNode.html" title="interface in org.apache.myfaces.custom.tree2"><CODE>TreeNode</CODE></A>.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/myfaces/custom/tree2/TreeNode.html#getType()">getType</A></B>()</CODE> + +<BR> + Gets the type of <A HREF="../../../../../org/apache/myfaces/custom/tree2/TreeNode.html" title="interface in org.apache.myfaces.custom.tree2"><CODE>TreeNode</CODE></A>.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/myfaces/custom/tree2/TreeNode.html#isLeaf()">isLeaf</A></B>()</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/myfaces/custom/tree2/TreeNode.html#setDescription(java.lang.String)">setDescription</A></B>(java.lang.String description)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/myfaces/custom/tree2/TreeNode.html#setIdentifier(java.lang.String)">setIdentifier</A></B>(java.lang.String identifier)</CODE> + +<BR> + Sets the identifier associated with the <A HREF="../../../../../org/apache/myfaces/custom/tree2/TreeNode.html" title="interface in org.apache.myfaces.custom.tree2"><CODE>TreeNode</CODE></A>.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/myfaces/custom/tree2/TreeNode.html#setLeaf(boolean)">setLeaf</A></B>(boolean leaf)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/myfaces/custom/tree2/TreeNode.html#setType(java.lang.String)">setType</A></B>(java.lang.String type)</CODE> + +<BR> + Sets the type of <A HREF="../../../../../org/apache/myfaces/custom/tree2/TreeNode.html" title="interface in org.apache.myfaces.custom.tree2"><CODE>TreeNode</CODE></A>.</TD> +</TR> +</TABLE> + +<P> + +<!-- ============ FIELD DETAIL =========== --> + + +<!-- ========= CONSTRUCTOR DETAIL ======== --> + + +<!-- ============ METHOD DETAIL ========== --> + +<A NAME="method_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TD COLSPAN=1><FONT SIZE="+2"> +<B>Method Detail</B></FONT></TD> +</TR> +</TABLE> + +<A NAME="isLeaf()"><!-- --></A><H3> +isLeaf</H3> +<PRE> +public boolean <B>isLeaf</B>()</PRE> +<DL> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="setLeaf(boolean)"><!-- --></A><H3> +setLeaf</H3> +<PRE> +public void <B>setLeaf</B>(boolean leaf)</PRE> +<DL> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getChildren()"><!-- --></A><H3> +getChildren</H3> +<PRE> +public java.util.List <B>getChildren</B>()</PRE> +<DL> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getType()"><!-- --></A><H3> +getType</H3> +<PRE> +public java.lang.String <B>getType</B>()</PRE> +<DL> +<DD>Gets the type of <A HREF="../../../../../org/apache/myfaces/custom/tree2/TreeNode.html" title="interface in org.apache.myfaces.custom.tree2"><CODE>TreeNode</CODE></A>. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> + +<DT><B>Returns:</B><DD>The node type</DL> +</DD> +</DL> +<HR> + +<A NAME="setType(java.lang.String)"><!-- --></A><H3> +setType</H3> +<PRE> +public void <B>setType</B>(java.lang.String type)</PRE> +<DL> +<DD>Sets the type of <A HREF="../../../../../org/apache/myfaces/custom/tree2/TreeNode.html" title="interface in org.apache.myfaces.custom.tree2"><CODE>TreeNode</CODE></A>. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>type</CODE> - The node type</DL> +</DD> +</DL> +<HR> + +<A NAME="getDescription()"><!-- --></A><H3> +getDescription</H3> +<PRE> +public java.lang.String <B>getDescription</B>()</PRE> +<DL> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="setDescription(java.lang.String)"><!-- --></A><H3> +setDescription</H3> +<PRE> +public void <B>setDescription</B>(java.lang.String description)</PRE> +<DL> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="setIdentifier(java.lang.String)"><!-- --></A><H3> +setIdentifier</H3> +<PRE> +public void <B>setIdentifier</B>(java.lang.String identifier)</PRE> +<DL> +<DD>Sets the identifier associated with the <A HREF="../../../../../org/apache/myfaces/custom/tree2/TreeNode.html" title="interface in org.apache.myfaces.custom.tree2"><CODE>TreeNode</CODE></A>. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getIdentifier()"><!-- --></A><H3> +getIdentifier</H3> +<PRE> +public java.lang.String <B>getIdentifier</B>()</PRE> +<DL> +<DD>Gets the identifier asociated with the <A HREF="../../../../../org/apache/myfaces/custom/tree2/TreeNode.html" title="interface in org.apache.myfaces.custom.tree2"><CODE>TreeNode</CODE></A>. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> + +<DT><B>Returns:</B><DD>the identifier</DL> +</DD> +</DL> +<HR> + +<A NAME="getChildCount()"><!-- --></A><H3> +getChildCount</H3> +<PRE> +public int <B>getChildCount</B>()</PRE> +<DL> +<DD>Gets the number of children this node has. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> + +<DT><B>Returns:</B><DD>the number of children</DL> +</DD> +</DL> +<!-- ========= END OF CLASS DATA ========= --> +<HR> + + +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<A NAME="navbar_bottom"><!-- --></A> +<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_bottom_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + PREV CLASS + NEXT CLASS</FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A> + <A HREF="TreeNode.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_bottom"></A> +<!-- ======== END OF BOTTOM NAVBAR ======= --> + +<HR> + +</BODY> +</HTML>
