You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by da...@apache.org on 2015/01/07 09:26:06 UTC

svn commit: r1650009 - in /isis/site/trunk/content/reference/recognized-annotations: CollectionLayout.md ParameterLayout.md PropertyLayout.md

Author: danhaywood
Date: Wed Jan  7 08:26:06 2015
New Revision: 1650009

URL: http://svn.apache.org/r1650009
Log:
named and namedEscaped; labelPosition to RIGHT

Modified:
    isis/site/trunk/content/reference/recognized-annotations/CollectionLayout.md
    isis/site/trunk/content/reference/recognized-annotations/ParameterLayout.md
    isis/site/trunk/content/reference/recognized-annotations/PropertyLayout.md

Modified: isis/site/trunk/content/reference/recognized-annotations/CollectionLayout.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/reference/recognized-annotations/CollectionLayout.md?rev=1650009&r1=1650008&r2=1650009&view=diff
==============================================================================
--- isis/site/trunk/content/reference/recognized-annotations/CollectionLayout.md (original)
+++ isis/site/trunk/content/reference/recognized-annotations/CollectionLayout.md Wed Jan  7 08:26:06 2015
@@ -6,7 +6,8 @@ annotation.
 * `cssClass` - the css class that a collection should have, to allow more targetted styling in `application.css`
 * `describedAs` - description of this collection, eg to be rendered in a tooltip.
 * `hidden` - indicates where in the UI the collection should *not* be visible in the UI (only NOWHERE or EVERWHERE/ANYWHERE)
-* `named` -the name of this property (overriding the name derived from its name in code)
+* `named` -the name of this collection (overriding the name derived from its name in code)
+* `namedEscaped` - whether to HTML escape the name of this property.  Defaults to true.
 * `paged` - the page size for instances of this class when rendered within a table.
 * `render` - that the rendering of a collection should be performed LAZILY or EAGERLY
 * `sortedBy` - Indicates that the elements in a ({@link java.util.SortedSet}) collection should be sorted according to a different order than the natural sort order, as defined by the specified{@link java.util.Comparator}
@@ -17,6 +18,8 @@ For example:
 
         @CollectionLayout(
             cssClass="x-key",
+            named="Todo items that are <i>dependencies</i> of this item.",
+            namedEscaped=false,
             describedAs="Other todo items that must be completed before this one",
             labelPosition=LabelPosition.LEFT,
             render=EAGERLY

Modified: isis/site/trunk/content/reference/recognized-annotations/ParameterLayout.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/reference/recognized-annotations/ParameterLayout.md?rev=1650009&r1=1650008&r2=1650009&view=diff
==============================================================================
--- isis/site/trunk/content/reference/recognized-annotations/ParameterLayout.md (original)
+++ isis/site/trunk/content/reference/recognized-annotations/ParameterLayout.md Wed Jan  7 08:26:06 2015
@@ -5,8 +5,9 @@ annotation.
 
 * `cssClass` - the css class that a parameter should have, to allow more targetted styling in `application.css`
 * `describedAs` - description of this parameter, eg to be rendered in a tooltip.
-* `labelPosition` - in forms, the positioning of the label (left, top or none) relative to the parameter value.  Defaults to LEFT unless `multiLine` also specified (see below)
+* `labelPosition` - in forms, the positioning of the label (LEFT, TOP or NONE) relative to the parameter value.  For boolean parameters it is also possible to specify RIGHT.  Defaults to LEFT unless `multiLine` also specified (see below)
 * `named` -the name of this parameter.  For Java 7 this is generally required.  For Java 8, the name can be inferred from the code so this attribute allows the name to be overridden.
+* `namedEscaped` - whether to HTML escape the name of this parameter.  Defaults to true.
 * `multiLine` - for string parameters, render as a text area over multiple lines.  If set >1, then `labelPosition` defaults to TOP unless otherwise specified.
 * `renderedAsDayBefore` - for date parameters only, render the date as one day prior to the actually stored date (eg the end date of an open interval into a closed interval)
 * `typicalLength` -the typical entry length of a field, use to determine the optimum width for display
@@ -20,7 +21,8 @@ For example:
                                     cssClass="x-key",
                                     describedAs="What needs to be done",
                                     labelPosition=LabelPosition.LEFT,
-                                    named="Description",
+                                    named="Description of this <i>item</i>",
+                                    namedEscaped=false,
                                     typicalLength=80)
                                 final String description) {
             setDescription(description);

Modified: isis/site/trunk/content/reference/recognized-annotations/PropertyLayout.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/reference/recognized-annotations/PropertyLayout.md?rev=1650009&r1=1650008&r2=1650009&view=diff
==============================================================================
--- isis/site/trunk/content/reference/recognized-annotations/PropertyLayout.md (original)
+++ isis/site/trunk/content/reference/recognized-annotations/PropertyLayout.md Wed Jan  7 08:26:06 2015
@@ -5,9 +5,10 @@ annotation:
 
 * `cssClass` - the css class that a property should have, to allow more targetted styling in `application.css`
 * `describedAs` - description of this property, eg to be rendered in a tooltip.
-* `labelPosition` - in forms, the positioning of the label (left, top or none) relative to the property value.  Defaults to LEFT unless `multiLine` also specified (see below)
+* `labelPosition` - in forms, the positioning of the label (LEFT, TOP or NONE) relative to the property value.  For boolean properties it is also possible to specify RIGHT.  Defaults to LEFT unless `multiLine` also specified (see below)
 * `hidden` - indicates where in the UI the property should *not* be visible in the UI
 * `named` -the name of this property (overriding the name derived from its name in code)
+* `namedEscaped` - whether to HTML escape the name of this property.  Defaults to true.
 * `multiLine` - for string properties, render as a text area over multiple lines.  If set >1, then `labelPosition` defaults to TOP unless otherwise specified.
 * `renderedAsDayBefore` - for date properties only, render the date as one day prior to the actually stored date (eg the end date of an open interval into a closed interval)
 * `typicalLength` -the typical entry length of a field, use to determine the optimum width for display
@@ -18,6 +19,8 @@ For example:
        
         @PropertyLayout(
             cssClass="x-key",
+            named="Description of this <i>item</i>",
+            namedEscaped=false,
             describedAs="What needs to be done",
             labelPosition=LabelPosition.LEFT,
             typicalLength=80)