You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@myfaces.apache.org by we...@apache.org on 2013/10/29 16:38:20 UTC

svn commit: r1536762 - /myfaces/tobago/trunk/tobago-extension/tobago-sandbox/src/main/java/org/apache/myfaces/tobago/internal/taglib/sandbox/SplitLayoutTagDeclaration.java

Author: weber
Date: Tue Oct 29 15:38:19 2013
New Revision: 1536762

URL: http://svn.apache.org/r1536762
Log:
TOBAGO-1332 - SplitLayout: a bit of documentation

Modified:
    myfaces/tobago/trunk/tobago-extension/tobago-sandbox/src/main/java/org/apache/myfaces/tobago/internal/taglib/sandbox/SplitLayoutTagDeclaration.java

Modified: myfaces/tobago/trunk/tobago-extension/tobago-sandbox/src/main/java/org/apache/myfaces/tobago/internal/taglib/sandbox/SplitLayoutTagDeclaration.java
URL: http://svn.apache.org/viewvc/myfaces/tobago/trunk/tobago-extension/tobago-sandbox/src/main/java/org/apache/myfaces/tobago/internal/taglib/sandbox/SplitLayoutTagDeclaration.java?rev=1536762&r1=1536761&r2=1536762&view=diff
==============================================================================
--- myfaces/tobago/trunk/tobago-extension/tobago-sandbox/src/main/java/org/apache/myfaces/tobago/internal/taglib/sandbox/SplitLayoutTagDeclaration.java (original)
+++ myfaces/tobago/trunk/tobago-extension/tobago-sandbox/src/main/java/org/apache/myfaces/tobago/internal/taglib/sandbox/SplitLayoutTagDeclaration.java Tue Oct 29 15:38:19 2013
@@ -14,8 +14,12 @@ import org.apache.myfaces.tobago.interna
 import org.apache.myfaces.tobago.internal.taglib.declaration.HasMargins;
 import org.apache.myfaces.tobago.internal.taglib.declaration.HasMarkup;
 import org.apache.myfaces.tobago.internal.taglib.declaration.HasSpacing;
-import org.apache.myfaces.tobago.layout.Orientation;
 
+  /**
+   * Renders a SplitLayout.
+   * A area with two child components rendered horizontally or vertically and allows to change the
+   * layout relation of this two components on the client.
+   */
 @Tag(name = "splitLayout", bodyContent = BodyContent.EMPTY)
 @UIComponentTag(
     uiComponent = "org.apache.myfaces.tobago.component.UISplitLayout",
@@ -27,10 +31,20 @@ import org.apache.myfaces.tobago.layout.
 public interface SplitLayoutTagDeclaration extends HasId, HasBorder, HasSpacing, HasMargin,
     HasMargins, HasBinding, HasMarkup, HasCurrentMarkup {
 
+  /**
+   * This value defines the layout constraints for the layout.
+   * It is two layout tokens separated by a semicolon. See GridLayout.
+   * Example: '2*;*'.
+   */
   @TagAttribute
   @UIComponentTagAttribute(defaultValue = "1*;1*")
   void setLayout(String rows);
 
+  /**
+   * This value defines the orientation of the split layout.
+   * Possible values are 'HORIZONTAL' and 'VERTICAL'.
+   */
+
   @TagAttribute
   @UIComponentTagAttribute(allowedValues = {"HORIZONTAL", "VERTICAL"})
   void setOrientation(String orientation);