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 2014/10/23 15:31:18 UTC
svn commit: r1633807 -
/isis/site/trunk/content/reference/recognized-annotations/
Author: danhaywood
Date: Thu Oct 23 13:31:18 2014
New Revision: 1633807
URL: http://svn.apache.org/r1633807
Log:
documenting annotations
Added:
isis/site/trunk/content/reference/recognized-annotations/ActionOrder-deprecated.md
- copied unchanged from r1630348, isis/site/trunk/content/reference/recognized-annotations/ActionOrder.md
isis/site/trunk/content/reference/recognized-annotations/CssClassFa.md
isis/site/trunk/content/reference/recognized-annotations/FieldOrder-deprecated.md
- copied unchanged from r1630348, isis/site/trunk/content/reference/recognized-annotations/FieldOrder.md
isis/site/trunk/content/reference/recognized-annotations/PostsPropertyChangedEvent-deprecated.md
- copied unchanged from r1630348, isis/site/trunk/content/reference/recognized-annotations/PostsPropertyChangedEvent.md
Removed:
isis/site/trunk/content/reference/recognized-annotations/ActionOrder.md
isis/site/trunk/content/reference/recognized-annotations/FieldOrder.md
isis/site/trunk/content/reference/recognized-annotations/PostsPropertyChangedEvent.md
Modified:
isis/site/trunk/content/reference/recognized-annotations/CssClass.md
isis/site/trunk/content/reference/recognized-annotations/about.md
Modified: isis/site/trunk/content/reference/recognized-annotations/CssClass.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/reference/recognized-annotations/CssClass.md?rev=1633807&r1=1633806&r2=1633807&view=diff
==============================================================================
--- isis/site/trunk/content/reference/recognized-annotations/CssClass.md (original)
+++ isis/site/trunk/content/reference/recognized-annotations/CssClass.md Thu Oct 23 13:31:18 2014
@@ -1,4 +1,55 @@
Title: @CssClass
-> this is a stub
+The `CssClass` annotation applies to object and also to any object member
+(property, collection or action). It is used by the Wicket viewer as a UI hint
+to render specified CSS classes around the representation of the element.
+Application-specific CSS can then be used to target and adjust the UI representation
+of that particular element.
+
+For example:
+
+ @CssClass("x-main")
+ public class ToDoItem { ... }
+
+or
+
+ public class ToDoItem {
+
+ @CssClass("x-key")
+ public LocalDate getDueBy() { ... }
+
+ }
+
+
+## Alternatives (`.layout.json`)
+
+As an alternative to using the `@CssClass` annotation, the `.layout.json`
+[dynamic layout file](../../components/viewers/wicket/dynamic-layouts.html)
+can be specified, eg:
+
+ {
+ "span": 6,
+ "memberGroups": {
+ "Priority": {
+ "members": {
+ ...
+ "dueBy": {
+ "cssClass": { "value": "x-key" }
+ }
+ ....
+ }
+ },
+ ...
+ }
+ }
+
+
+Note that this (currently) only supports class members, not classes
+
+
+## See also (1.8.0-SNAPSHOT)
+
+The similar [CssClassFa](./CssClassFa.html) annotation is also used as a hint
+to apply CSS, but in particular to allow [Font Awesome icons](http://fortawesome.github.io/Font-Awesome/icons/)
+to be rendered on action butotns or as the icon for classes.
Added: isis/site/trunk/content/reference/recognized-annotations/CssClassFa.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/reference/recognized-annotations/CssClassFa.md?rev=1633807&view=auto
==============================================================================
--- isis/site/trunk/content/reference/recognized-annotations/CssClassFa.md (added)
+++ isis/site/trunk/content/reference/recognized-annotations/CssClassFa.md Thu Oct 23 13:31:18 2014
@@ -0,0 +1,70 @@
+Title: @CssClassFa (1.8.0-SNAPSHOT)
+
+The `CssClassFa` annotation applies to objects and also to object actions,
+and is used by the Wicket viewer as a UI hint.
+
+For object actions, the viewer will render the specified
+[Font Awesome icon](http://fortawesome.github.io/Font-Awesome/icons/)
+on the action's button (or menu item).
+
+For objects, it will be used as an icon. Note that this is only used if
+the object does not have a `getIconName()` method.
+
+For example:
+
+ @CssClassFa("fa-check-circle")
+ public class ToDoItem { ... }
+
+or
+
+ public class ToDoItem {
+
+ @CssClass("fa-step-backward")
+ public ToDoItem previous() { ... }
+
+ @CssClass("fa-step-forward")
+ public ToDoItem next() { ... }
+
+ }
+
+There can be multiple "fa-" classes, eg to mirror or rotate the icon. There
+is no need to include the "fa" class; it will be automatically appended.
+
+## Alternatives (`.layout.json`)
+
+As an alternative to using the `@CssClass` annotation, the `.layout.json`
+[dynamic layout file](../../components/viewers/wicket/dynamic-layouts.html)
+can be specified, eg:
+
+ {
+ "span": 6,
+ "memberGroups": {
+ "Priority": {
+ "members": {
+ ...
+ "relativePriority": {
+ "actions": {
+ "previous": {
+ "cssClassFa": { "value": "fa-step-backward" }
+ },
+ "next": {
+ "cssClassFa": { "value": "fa-step-forward" }
+ }
+ }
+ },
+ ....
+ }
+ },
+ ...
+ }
+ }
+
+
+Note that this (currently) only supports class members, not classes.
+
+## See also
+
+The similar [CssClass](./CssClass.html) annotation is also used as a hint
+to apply CSS, but for wrapping the representation of an object or object
+member so that it can be styled in an application-specific way.
+
Modified: isis/site/trunk/content/reference/recognized-annotations/about.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/reference/recognized-annotations/about.md?rev=1633807&r1=1633806&r2=1633807&view=diff
==============================================================================
--- isis/site/trunk/content/reference/recognized-annotations/about.md (original)
+++ isis/site/trunk/content/reference/recognized-annotations/about.md Thu Oct 23 13:31:18 2014
@@ -2,62 +2,70 @@ title: Recognized Annotations
go back to: [documentation](../../documentation.html)
-* [@ActionOrder](./ActionOrder.html) (deprecated)
-* [@ActionSemantics](./ActionSemantics.html)
-* [@Aggregated](./Aggregated.html)
-* [@Audited](./Audited.html)
-* [@AutoComplete](./AutoComplete.html)
-* [@Bookmarkable](./Bookmarkable.html)
-* [@Bounded](./Bounded.html)
-* [@Bulk](./Bulk.html)
-* [@Command](./Command.html)
-* [@CssClass](./CssClass.html)
-* [@Debug](./Debug.html)
-* [@Defaulted](./Defaulted.html)
-* [@DescribedAs](./DescribedAs.html)
-* [@Disabled](./Disabled.html)
-* [@Encodable](./Encodable.html)
-* [@EqualByContent](./EqualByContent.html)
-* [@Exploration](./Exploration.html)
-* [@Facets](./Facets.html)
-* [@FieldOrder](./FieldOrder.html) (deprecated)
-* [@Hidden](./Hidden.html)
-* [@HomePage](./HomePage.html)
-* [@Idempotent](./Idempotent-deprecated.html) (deprecated)
-* [@Ignore-deprecated](./Ignore-deprecated.html) (deprecated)
-* [@Immutable-deprecated](./Immutable.html)
-* [@javax.inject.Inject](./Inject.html)
-* [@Mask](./Mask.html)
-* [@MaxLength](./MaxLength.html)
-* [@MemberGroupLayout](./MemberGroupLayout.html)
-* [@MemberGroups](./MemberGroups.html)
-* [@MemberOrder](./MemberOrder.html)
-* [@MinLength](./MinLength.html)
-* [@MultiLine](./MultiLine.html)
-* [@MustSatisfy](./MustSatisfy.html)
-* [@Named](./Named.html)
-* [@NotContributed](./NotContributed.html)
-* [@NotInServiceMenu](./NotInServiceMenu.html)
-* [@NotPersistable](./NotPersistable.html)
-* [@NotPersisted](./NotPersisted.html)
-* [@ObjectType](./ObjectType.html)
-* [@Optional](./Optional.html)
-* [@Paged](./Paged.html)
-* [@Parseable](./Parseable.html)
-* [@Plural](./Plural.html)
-* [@PostsPropertyChangeEvent](./PostsPropertyChangeEvent.html)
-* [@Programmatic](./Programmatic.html)
-* [@Prototype](./Prototype.html)
-* [@PublishedAction](./Prototype.html)
-* [@PublishedObject](./PublishedObject.html)
-* [@QueryOnly-deprecated](./QueryOnly-deprecated.html) (deprecated)
-* [@RegEx](./RegEx.html)
-* [@Render](./Render.html)
-* [@RenderedAsDayBefore](./RenderedAsDayBefore.html)
-* [@javax.enterprise.context.RequestScoped](./RequestScoped.html)
-* [@Resolve](./Resolve.html)
-* [@SortedBy](./SortedBy.html)
-* [@Title](./Title.html)
-* [@TypeOf](./TypeOf.html)
-* [@TypicalLength](./TypicalLength.html)
-* [@Value](./Value.html)
+<table>
+<tr>
+ <th>Annotation</th>
+ <th>.layout.json ?</th>
+ <th>Deprecated?</th>
+</tr>
+<tr><td><a href="./ActionOrder-deprecated.html">@ActionOrder</a></td><td></td><td>Y</td></tr>
+<tr><td><a href="./ActionSemantics.html">@ActionSemantics</a></td><td></td><td></td></tr>
+<tr><td><a href="./Aggregated.html">@Aggregated</a></td><td></td><td></td></tr>
+<tr><td><a href="./Audited.html">@Audited</a></td><td></td><td></td></tr>
+<tr><td><a href="./AutoComplete.html">@AutoComplete</a></td><td></td><td></td></tr>
+<tr><td><a href="./Bookmarkable.html">@Bookmarkable</a></td><td></td><td></td></tr>
+<tr><td><a href="./Bounded.html">@Bounded</a></td><td></td><td></td></tr>
+<tr><td><a href="./Bulk.html">@Bulk</a></td><td></td><td></td></tr>
+<tr><td><a href="./Command.html">@Command</a></td><td></td><td></td></tr>
+<tr><td><a href="./CssClass.html">@CssClass</a></td><td>Y</td><td></td></tr>
+<tr><td><a href="./CssClassFa.html">@CssClassFa</a></td><td>Y</td><td></td></tr>
+<tr><td><a href="./Debug.html">@Debug</a></td><td></td><td></td></tr>
+<tr><td><a href="./Defaulted.html">@Defaulted</a></td><td></td><td></td></tr>
+<tr><td><a href="./DescribedAs.html">@DescribedAs</a></td><td>Y</td><td></td></tr>
+<tr><td><a href="./Disabled.html">@Disabled</a></td><td>Y</td><td></td></tr>
+<tr><td><a href="./Encodable.html">@Encodable</a></td><td></td><td></td></tr>
+<tr><td><a href="./EqualByContent.html">@EqualByContent</a></td><td></td><td></td></tr>
+<tr><td><a href="./Exploration.html">@Exploration</a></td><td></td><td></td></tr>
+<tr><td><a href="./Facets.html">@Facets</a></td><td></td><td></td></tr>
+<tr><td><a href="./FieldOrder-deprecated.html">@FieldOrder</a></td><td></td><td>Y</td></tr>
+<tr><td><a href="./Hidden.html">@Hidden</a></td><td>Y</td><td></td></tr>
+<tr><td><a href="./HomePage.html">@HomePage</a></td><td></td><td></td></tr>
+<tr><td><a href="./Idempotent-deprecated.html">@Idempotent</a></td><td></td><td>Y</td></tr>
+<tr><td><a href="./Ignore-deprecated.html">@Ignore</a></td><td></td><td>Y</td></tr>
+<tr><td><a href="./Immutable.html">@Immutable</a></td><td></td><td></td></tr>
+<tr><td><a href="./Inject.html">@javax.inject.Inject</a></td><td></td><td></td></tr>
+<tr><td><a href="./Mask.html">@Mask</a></td><td></td><td></td></tr>
+<tr><td><a href="./MaxLength.html">@MaxLength</a></td><td></td><td></td></tr>
+<tr><td><a href="./MemberGroupLayout.html">@MemberGroupLayout</a></td><td></td><td></td></tr>
+<tr><td><a href="./MemberGroups.html">@MemberGroups</a></td><td></td><td></td></tr>
+<tr><td><a href="./MemberOrder.html">@MemberOrder</a></td><td></td><td></td></tr>
+<tr><td><a href="./MinLength.html">@MinLength</a></td><td></td><td></td></tr>
+<tr><td><a href="./MultiLine.html">@MultiLine</a></td><td>Y</td><td></td></tr>
+<tr><td><a href="./MustSatisfy.html">@MustSatisfy</a></td><td></td><td></td></tr>
+<tr><td><a href="./Named.html">@Named</a></td><td>Y</td><td></td></tr>
+<tr><td><a href="./NotContributed.html">@NotContributed</a></td><td></td><td></td></tr>
+<tr><td><a href="./NotInServiceMenu.html">@NotInServiceMenu</a></td><td></td><td></td></tr>
+<tr><td><a href="./NotPersistable.html">@NotPersistable</a></td><td></td><td></td></tr>
+<tr><td><a href="./NotPersisted.html">@NotPersisted</a></td><td></td><td></td></tr>
+<tr><td><a href="./ObjectType.html">@ObjectType</a></td><td></td><td></td></tr>
+<tr><td><a href="./Optional.html">@Optional</a></td><td></td><td></td></tr>
+<tr><td><a href="./Paged.html">@Paged</a></td><td></td><td></td></tr>
+<tr><td><a href="./Parseable.html">@Parseable</a></td><td></td><td></td></tr>
+<tr><td><a href="./Plural.html">@Plural</a></td><td></td><td></td></tr>
+<tr><td><a href="./PostsPropertyChangeEvent-deprecated.html">@PostsPropertyChangeEvent</a></td><td></td><td>Y</td></tr>
+<tr><td><a href="./Programmatic.html">@Programmatic</a></td><td></td><td></td></tr>
+<tr><td><a href="./Prototype.html">@Prototype</a></td><td></td><td></td></tr>
+<tr><td><a href="./Prototype.html">@PublishedAction</a></td><td></td><td></td></tr>
+<tr><td><a href="./PublishedObject.html">@PublishedObject</a></td><td></td><td></td></tr>
+<tr><td><a href="./QueryOnly-deprecated.html">@QueryOnly</a></td><td></td><td>Y</td></tr>
+<tr><td><a href="./RegEx.html">@RegEx</a></td><td></td><td></td></tr>
+<tr><td><a href="./Render.html">@Render</a></td><td></td><td></td></tr>
+<tr><td><a href="./RenderedAsDayBefore.html">@RenderedAsDayBefore</a></td><td></td><td></td></tr>
+<tr><td><a href="./RequestScoped.html">@javax.enterprise.context.RequestScoped</a></td><td></td><td></td></tr>
+<tr><td><a href="./Resolve.html">@Resolve</a></td><td></td><td></td></tr>
+<tr><td><a href="./SortedBy.html">@SortedBy</a></td><td></td><td></td></tr>
+<tr><td><a href="./Title.html">@Title</a></td><td></td><td></td></tr>
+<tr><td><a href="./TypeOf.html">@TypeOf</a></td><td></td><td></td></tr>
+<tr><td><a href="./TypicalLength.html">@TypicalLength</a></td><td>Y</td><td></td></tr>
+<tr><td><a href="./Value.html">Value</a></td><td></td><td></td></tr></tr>
+</table>