svn commit: r557020 - /myfaces/trinidad/trunk/plugins/maven-tagdoc-plugin/src/main/java/org/apache/myfaces/trinidadbuild/plugin/tagdoc/TagdocReport.java

[aw...@apache.org]

Author: awiner
Date: Tue Jul 17 11:47:16 2007
New Revision: 557020

URL: http://svn.apache.org/viewvc?view=rev&rev=557020
Log:
TRINIDAD-109: Tagdoc should doc when a component is a naming container

Modified:
    myfaces/trinidad/trunk/plugins/maven-tagdoc-plugin/src/main/java/org/apache/myfaces/trinidadbuild/plugin/tagdoc/TagdocReport.java

Modified: myfaces/trinidad/trunk/plugins/maven-tagdoc-plugin/src/main/java/org/apache/myfaces/trinidadbuild/plugin/tagdoc/TagdocReport.java
URL: http://svn.apache.org/viewvc/myfaces/trinidad/trunk/plugins/maven-tagdoc-plugin/src/main/java/org/apache/myfaces/trinidadbuild/plugin/tagdoc/TagdocReport.java?view=diff&rev=557020&r1=557019&r2=557020
==============================================================================
--- myfaces/trinidad/trunk/plugins/maven-tagdoc-plugin/src/main/java/org/apache/myfaces/trinidadbuild/plugin/tagdoc/TagdocReport.java (original)
+++ myfaces/trinidad/trunk/plugins/maven-tagdoc-plugin/src/main/java/org/apache/myfaces/trinidadbuild/plugin/tagdoc/TagdocReport.java Tue Jul 17 11:47:16 2007
@@ -548,6 +548,13 @@
     out.write("   <b>Component type:</b> " + bean.getComponentType() +  "\n");
     out.write("   <br/>\n");
 
+    if (_isNamingContainer(bean))
+    {
+      out.write("   <p><b>Naming container:</b>  Yes.  When referring to children of this " +
+                "component (\"partialTriggers\", <code>findComponent()</code>, etc.), " +
+                "you must prefix the child's ID with this component's ID and a colon (':').</p>");
+    }
+      
     String fmtd = _formatPropList(bean.getUnsupportedAgents(),
                                   "Unsupported agents",
                                   _NON_DOCUMENTED_AGENTS);
@@ -564,6 +571,17 @@
     out.write("\n");
   }
 
+
+  private boolean _isNamingContainer(ComponentBean bean)
+  {
+    if (bean.isNamingContainer())
+      return true;
+
+    ComponentBean parent = bean.resolveSupertype();
+    if (parent == null)
+      return false;
+    return _isNamingContainer(parent);
+  }
 
   private void _writeValidatorSummary(Writer out, ValidatorBean bean) throws IOException
   {