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/12/05 08:03:33 UTC
svn commit: r1643166 [1/2] - in /isis/site/trunk/content:
components/viewers/wicket/ how-tos/ intro/learning-more/ intro/tutorials/
more-advanced-topics/ reference/ reference/recognized-annotations/
reference/services/ reference/ui/
Author: danhaywood
Date: Fri Dec 5 07:03:32 2014
New Revision: 1643166
URL: http://svn.apache.org/viewvc?rev=1643166&view=rev
Log:
layout annotations
Added:
isis/site/trunk/content/reference/recognized-annotations/ActionLayout.md
- copied, changed from r1633831, isis/site/trunk/content/reference/recognized-annotations/ActionInteraction.md
isis/site/trunk/content/reference/recognized-annotations/ClassLayout.md
isis/site/trunk/content/reference/recognized-annotations/CollectionLayout.md
isis/site/trunk/content/reference/recognized-annotations/CssClass-deprecated.md
- copied, changed from r1633807, isis/site/trunk/content/reference/recognized-annotations/CssClass.md
isis/site/trunk/content/reference/recognized-annotations/CssClassFa-deprecated.md
- copied, changed from r1633807, isis/site/trunk/content/reference/recognized-annotations/CssClassFa.md
isis/site/trunk/content/reference/recognized-annotations/DescribedAs-deprecated.md
- copied, changed from r1630348, isis/site/trunk/content/reference/recognized-annotations/DescribedAs.md
isis/site/trunk/content/reference/recognized-annotations/Hidden-deprecated.md
- copied, changed from r1630348, isis/site/trunk/content/reference/recognized-annotations/Hidden.md
isis/site/trunk/content/reference/recognized-annotations/Mask-deprecated.md
- copied unchanged from r1630348, isis/site/trunk/content/reference/recognized-annotations/Mask.md
isis/site/trunk/content/reference/recognized-annotations/MemberGroups-deprecated.md
- copied unchanged from r1630348, isis/site/trunk/content/reference/recognized-annotations/MemberGroups.md
isis/site/trunk/content/reference/recognized-annotations/MultiLine-deprecated.md
- copied, changed from r1630348, isis/site/trunk/content/reference/recognized-annotations/MultiLine.md
isis/site/trunk/content/reference/recognized-annotations/Named-deprecated.md
- copied, changed from r1630348, isis/site/trunk/content/reference/recognized-annotations/Named.md
isis/site/trunk/content/reference/recognized-annotations/Paged-deprecated.md
- copied, changed from r1630348, isis/site/trunk/content/reference/recognized-annotations/Paged.md
isis/site/trunk/content/reference/recognized-annotations/ParameterLayout.md
isis/site/trunk/content/reference/recognized-annotations/Plural-deprecated.md
- copied, changed from r1630348, isis/site/trunk/content/reference/recognized-annotations/Plural.md
isis/site/trunk/content/reference/recognized-annotations/PropertyLayout.md
- copied, changed from r1634037, isis/site/trunk/content/reference/recognized-annotations/LabelAt.md
isis/site/trunk/content/reference/recognized-annotations/Prototype-deprecated.md
- copied, changed from r1630348, isis/site/trunk/content/reference/recognized-annotations/Prototype.md
isis/site/trunk/content/reference/recognized-annotations/SortedBy-deprecated.md
- copied, changed from r1630348, isis/site/trunk/content/reference/recognized-annotations/SortedBy.md
isis/site/trunk/content/reference/ui/
isis/site/trunk/content/reference/ui/ActionPositioning.pdf (with props)
isis/site/trunk/content/reference/ui/ActionPositioning.pptx (with props)
Removed:
isis/site/trunk/content/reference/recognized-annotations/CssClass.md
isis/site/trunk/content/reference/recognized-annotations/CssClassFa.md
isis/site/trunk/content/reference/recognized-annotations/DescribedAs.md
isis/site/trunk/content/reference/recognized-annotations/Hidden.md
isis/site/trunk/content/reference/recognized-annotations/LabelAt.md
isis/site/trunk/content/reference/recognized-annotations/Mask.md
isis/site/trunk/content/reference/recognized-annotations/MemberGroups.md
isis/site/trunk/content/reference/recognized-annotations/MultiLine.md
isis/site/trunk/content/reference/recognized-annotations/Named.md
isis/site/trunk/content/reference/recognized-annotations/Paged.md
isis/site/trunk/content/reference/recognized-annotations/Plural.md
isis/site/trunk/content/reference/recognized-annotations/Prototype.md
isis/site/trunk/content/reference/recognized-annotations/SortedBy.md
Modified:
isis/site/trunk/content/components/viewers/wicket/static-layouts.md
isis/site/trunk/content/how-tos/how-to-01-070-How-to-specify-the-icon-for-a-domain-entity.md
isis/site/trunk/content/intro/learning-more/articles-and-presentations.md
isis/site/trunk/content/intro/tutorials/apacheconeu-2014.md
isis/site/trunk/content/more-advanced-topics/ViewModel.md
isis/site/trunk/content/reference/deployment-type.md
isis/site/trunk/content/reference/recognized-annotations/DomainService.md
isis/site/trunk/content/reference/recognized-annotations/Exploration-deprecated.md
isis/site/trunk/content/reference/recognized-annotations/Render.md
isis/site/trunk/content/reference/recognized-annotations/TypicalLength.md
isis/site/trunk/content/reference/recognized-annotations/ViewModel.md
isis/site/trunk/content/reference/recognized-annotations/about.md
isis/site/trunk/content/reference/services/developer-utilities-service.md
Modified: isis/site/trunk/content/components/viewers/wicket/static-layouts.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/components/viewers/wicket/static-layouts.md?rev=1643166&r1=1643165&r2=1643166&view=diff
==============================================================================
--- isis/site/trunk/content/components/viewers/wicket/static-layouts.md (original)
+++ isis/site/trunk/content/components/viewers/wicket/static-layouts.md Fri Dec 5 07:03:32 2014
@@ -131,7 +131,7 @@ Below are sketches for the layout of the
## Other Annotations
-The [@Named](../../../reference/recognized-annotations/Named.html), [@DescribedAs](../../../reference/recognized-annotations/DescribedAs.html), [@MultiLine](../../../reference/recognized-annotations/MultiLine.html), [@TypicalLength](../../../reference/recognized-annotations/TypicalLength.html), [@Render](../../../reference/recognized-annotations/Render.html) and [@CssClass](../../../reference/recognized-annotations/CssClass.html) annotations are also all hints that can affect the UI.
+The [@Named](../../../reference/recognized-annotations/Named-deprecated.html), [@DescribedAs](../../../reference/recognized-annotations/DescribedAs-deprecated.html), [@MultiLine](../../../reference/recognized-annotations/MultiLine-deprecated.html), [@TypicalLength](../../../reference/recognized-annotations/TypicalLength-deprecated.html), [@Render](../../../reference/recognized-annotations/Render-deprecated.html) and [@CssClass](../../../reference/recognized-annotations/CssClass-deprecated.html) annotations are also all hints that can affect the UI.
## <a name="pros-and-cons">Static vs Dynamic Layouts</a>
Modified: isis/site/trunk/content/how-tos/how-to-01-070-How-to-specify-the-icon-for-a-domain-entity.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/how-tos/how-to-01-070-How-to-specify-the-icon-for-a-domain-entity.md?rev=1643166&r1=1643165&r2=1643166&view=diff
==============================================================================
--- isis/site/trunk/content/how-tos/how-to-01-070-How-to-specify-the-icon-for-a-domain-entity.md (original)
+++ isis/site/trunk/content/how-tos/how-to-01-070-How-to-specify-the-icon-for-a-domain-entity.md Fri Dec 5 07:03:32 2014
@@ -50,7 +50,7 @@ The viewer stops searching as soon as a
If a dynamic icon has not been specified, then the viewer will next attempt to load a [font awesome](http://fortawesome.github.io/Font-Awesome/) icon.
-For this, the class needs to be annotated with the [`@CssClassFa`](../reference/recognized-annotations/CssClassFa.html) annotation:
+For this, the class needs to be annotated with the [`@CssClassFa`](../reference/recognized-annotations/CssClassFa-deprecated.html) annotation:
@CssClass("fa fa-check-square-o")
public class TodoItem {
Modified: isis/site/trunk/content/intro/learning-more/articles-and-presentations.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/intro/learning-more/articles-and-presentations.md?rev=1643166&r1=1643165&r2=1643166&view=diff
==============================================================================
--- isis/site/trunk/content/intro/learning-more/articles-and-presentations.md (original)
+++ isis/site/trunk/content/intro/learning-more/articles-and-presentations.md Fri Dec 5 07:03:32 2014
@@ -4,9 +4,7 @@ Some articles and recorded material rela
2014
-<!--
-* Presentation, BDD Exchange: [To those whom much is given, much is expected... ](xxx) (45 min. video)
--->
+* Presentation, BDD Exchange: [To those whom much is given, much is expected... ](https://skillsmatter.com/skillscasts/5638-to-those-whom-much-is-given-much-is-expected) (45 min. video)
* Presentation, JEEConf: [Extremely rapid application development with Apache Isis](https://www.youtube.com/watch?v=BNGUqZ6YE-M) (50 min. video)
2013
Modified: isis/site/trunk/content/intro/tutorials/apacheconeu-2014.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/intro/tutorials/apacheconeu-2014.md?rev=1643166&r1=1643165&r2=1643166&view=diff
==============================================================================
--- isis/site/trunk/content/intro/tutorials/apacheconeu-2014.md (original)
+++ isis/site/trunk/content/intro/tutorials/apacheconeu-2014.md Fri Dec 5 07:03:32 2014
@@ -274,7 +274,7 @@ Domain entities have state: either value
* add some [value properties](http://isis.apache.org/how-tos/how-to-01-030-How-to-add-a-property-to-a-domain-entity.html); also:
- for string properties
- - use the [@Multiline](http://isis.apache.org/reference/recognized-annotations/MultiLine.html) annotation to render a text area instead of a text box
+ - use the [@MultiLine](http://isis.apache.org/reference/recognized-annotations/MultiLine-deprecated.html) annotation to render a text area instead of a text box
- use the [@MaxLength](http://isis.apache.org/reference/recognized-annotations/MaxLength.html) annotation to specify the maximum number of characters allowable
- use [joda date/time](http://isis.apache.org/components/objectstores/jdo/mapping-joda-dates.html) properties
- use [bigdecimals](http://isis.apache.org/components/objectstores/jdo/mapping-bigdecimals.html) properties
@@ -287,7 +287,7 @@ Domain entities have state: either value
- might prefer to use [@Title](http://isis.apache.org/reference/recognized-annotations/Title.html) annotation rather than the `title()` method
* [order the properties](http://isis.apache.org/how-tos/how-to-01-080-How-to-specify-the-order-in-which-properties-or-collections-are-displayed.html) using the [@MemberOrder](http://isis.apache.org/reference/recognized-annotations/MemberOrder.html) annotation and [@MemberGroupLayout](http://isis.apache.org/reference/recognized-annotations/MemberGroupLayout.html) annotation
* see also this [static layouts](http://isis.apache.org/components/viewers/wicket/static-layouts.html) documentation
-* use the [@LabelAt](http://isis.apache.org/reference/recognized-annotations/about.html) annotation to position property labels either to the LEFT, TOP or NONE
+* use the [@PropertyLayout](http://isis.apache.org/reference/recognized-annotations/about.html) annotation and [@ParameterLayout](http://isis.apache.org/reference/recognized-annotations/about.html) annotation to position property/action parameter labels either to the LEFT, TOP or NONE
@@ -324,8 +324,8 @@ Returning back to references, Isis also
* use the [ObjectContracts](http://isis.apache.org/reference/Utility.html) utility class to help implement `Comparable` (also `equals()`, `hashCode()`, `toString()`)
* Add a [one-to-many-collection](http://isis.apache.org/components/objectstores/jdo/managed-1-to-m-relationships.html) to one of the entities
* Use `SortedSet` as the class
-* Use the @Render (http://isis.apache.org/reference/recognized-annotations/Render.html) annotation to indicate if the collection should be visible or hidden by default
-* optional: Use the [@SortedBy](http://isis.apache.org/reference/recognized-annotations/SortedBy.html) annotation to specify a different comparator than the natural ordering
+* Use the @Render (http://isis.apache.org/reference/recognized-annotations/Render-deprecated.html) annotation to indicate if the collection should be visible or hidden by default
+* optional: Use the [@SortedBy](http://isis.apache.org/reference/recognized-annotations/SortedBy-deprecated.html) annotation to specify a different comparator than the natural ordering
@@ -348,7 +348,7 @@ The Wicket UI doesn't allow collections
(In 1.8.0-SNAPSHOT), CSS classes can be associated with any class member (property, collection, action). But for actions in particular:
- the bootstrap "btn" CSS classes can be used using [@CssClass](http://isis.apache.org/reference/recognized-annotations/CssClass.html) annotation
-- the [Font Awesome](http://fortawesome.github.io/Font-Awesome/icons/) icons can be used using the [@CssClassFa](http://isis.apache.org/reference/recognized-annotations/CssClassFa.html) annotation
+- the [Font Awesome](http://fortawesome.github.io/Font-Awesome/icons/) icons can be used using the [@CssClassFa](http://isis.apache.org/reference/recognized-annotations/CssClassFa-deprecated.html) annotation
It's also possible to use Font Awesome icons for the [domain object icon](http://isis.apache.org/how-tos/how-to-01-070-How-to-specify-the-icon-for-a-domain-entity.html).
@@ -359,7 +359,7 @@ So:
## Dynamic Layout
-Up to this point we've been using annotations (`@MemberOrder`, `@MemberGroupLayout`, `@Named`, `@LabelAt`, `@CssClass` and `@CssClassFa` and so on) for UI hints. However, the feedback loop is not good: it requires us stopping the app, editing the code, recompiling and running again. So instead, all these UI hints (and more) can be specified dynamically, using a corresponding `.layout.json` file. If edited while the app is running, it will be reloaded automatically (in IntelliJ, use Run>Reload Changed Classes):
+Up to this point we've been using annotations (`@MemberOrder`, `@MemberGroupLayout`, `@Named`, `@PropertyLayout`, `@ParameterLayout`, `@CssClass` and `@CssClassFa` and so on) for UI hints. However, the feedback loop is not good: it requires us stopping the app, editing the code, recompiling and running again. So instead, all these UI hints (and more) can be specified dynamically, using a corresponding `.layout.json` file. If edited while the app is running, it will be reloaded automatically (in IntelliJ, use Run>Reload Changed Classes):
* Delete the various hint annotations and instead specify layout hints using a [.layout.json](http://isis.apache.org/components/viewers/wicket/dynamic-layouts.html) file.
@@ -378,7 +378,7 @@ Or, more pithily: "see it, use it, do it
#### See it!
-* Use the [@Hidden](http://isis.apache.org/reference/recognized-annotations/Hidden.html) annotation to make properties/collections/actions invisible
+* Use the [@Hidden](http://isis.apache.org/reference/recognized-annotations/Hidden-deprecated.html) annotation to make properties/collections/actions invisible
* the [@Programmatic](http://isis.apache.org/reference/recognized-annotations/Programmatic.html) annotation can also be used and in many cases is to be preferred; the difference is that the latter means the member is not part of the Isis metamodel.
* Use the `hideXxx()` supporting method on [properties](http://isis.apache.org/how-tos/how-to-02-010-How-to-hide-a-property.html), [collections](http://isis.apache.org/how-tos/how-to-02-020-How-to-hide-a-collection.html) and [actions](http://isis.apache.org/how-tos/how-to-02-030-How-to-hide-an-action.html) to make a property/collection/action invisible according to some imperative rule
Modified: isis/site/trunk/content/more-advanced-topics/ViewModel.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/more-advanced-topics/ViewModel.md?rev=1643166&r1=1643165&r2=1643166&view=diff
==============================================================================
--- isis/site/trunk/content/more-advanced-topics/ViewModel.md (original)
+++ isis/site/trunk/content/more-advanced-topics/ViewModel.md Fri Dec 5 07:03:32 2014
@@ -35,7 +35,7 @@ View models must have a no-arg construct
> Note that there is a `DomainObjectContainer#newViewModelInstance(.)`; this is for view models that implement `ViewModel` interface and can be safely ignored.
>
-The view model's memento will be derived from the value of the view model object's properties. Any [@NotPersistent](http://isis.apache.org/reference/recognized-annotations/NotPersistent.html) properties will be excluded from the memento, as will any [@Programmatic](http://isis.apache.org/reference/recognized-annotations/Programmatic.html) properties. Properties that are merely [@Hidden](http://isis.apache.org/reference/recognized-annotations/Hidden.html) are included in the memento.
+The view model's memento will be derived from the value of the view model object's properties. Any [@NotPersistent](http://isis.apache.org/reference/recognized-annotations/NotPersistent.html) properties will be excluded from the memento, as will any [@Programmatic](http://isis.apache.org/reference/recognized-annotations/Programmatic.html) properties. Properties that are merely [@Hidden](http://isis.apache.org/reference/recognized-annotations/Hidden-deprecated.html) are included in the memento.
Only properties supported by the configured [MementoService](../reference/services/memento-service.html) can be used. The default implementation supports all the value types and persisted entities.
Modified: isis/site/trunk/content/reference/deployment-type.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/reference/deployment-type.md?rev=1643166&r1=1643165&r2=1643166&view=diff
==============================================================================
--- isis/site/trunk/content/reference/deployment-type.md (original)
+++ isis/site/trunk/content/reference/deployment-type.md Fri Dec 5 07:03:32 2014
@@ -2,7 +2,7 @@ Title: Deployment Types
The `deploymentType` configuration setting is used to specify whether Isis is running in development mode or production mode (similar to Apache Wicket's concept of the application's [configuration type](http://ci.apache.org/projects/wicket/apidocs/6.0.x/org/apache/wicket/Application.html#getConfigurationType()).
-The most notable thing that varies by `deploymentType` is simply whether actions annotated with [@Prototype](./recognized-annotations/Prototype.html) are visible.
+The most notable thing that varies by `deploymentType` is simply whether actions annotated with [@Prototype](./recognized-annotations/Prototype-deprecated.html) are visible.
Each `deploymentType` list has a corresponding `deploymentCategory`, and it is this that determines whether `@Prototype` actions are visible:
Copied: isis/site/trunk/content/reference/recognized-annotations/ActionLayout.md (from r1633831, isis/site/trunk/content/reference/recognized-annotations/ActionInteraction.md)
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/reference/recognized-annotations/ActionLayout.md?p2=isis/site/trunk/content/reference/recognized-annotations/ActionLayout.md&p1=isis/site/trunk/content/reference/recognized-annotations/ActionInteraction.md&r1=1633831&r2=1643166&rev=1643166&view=diff
==============================================================================
--- isis/site/trunk/content/reference/recognized-annotations/ActionInteraction.md (original)
+++ isis/site/trunk/content/reference/recognized-annotations/ActionLayout.md Fri Dec 5 07:03:32 2014
@@ -1,135 +1,16 @@
-Title: @ActionInteraction
+Title: @ActionLayout (1.8.0-SNAPSHOT)
-> Support
->
-> Supported by all viewers (implementation is part of core metamodel)
-
-The `@ActionInteraction` annotation applies to domain entity actions, allowing
-subscribers to optionally veto, validate or otherwise perform tasks before
-or after the action has been invoked.
-
-Subscribers subscribe through the [Event Bus Service](../services/event-bus-service.html) using Guava annotations.
-
-By default the event raised is `ActionInteractionEvent.Default`. For example:
-
- public class ToDoItem {
- ...
- @ActionInteraction
- public ToDoItem completed() { ... }
- }
-
-Optionally a subclass can be declared:
-
- public class ToDoItem {
-
- public static class CompletedEvent extends AbstractActionInteractionEvent {
- private static final long serialVersionUID = 1L;
- public CompletedEvent(
- final ToDoItem source,
- final Identifier identifier,
- final Object... arguments) {
- super("completed", source, identifier, arguments);
- }
- }
-
- @ActionInteraction(CompletedEvent.class)
- public ToDoItem completed() { ... }
-
- }
-
-
-## Subscribers
-
-Subscribers (which must be domain services) subscribe using the Guava API.
-Subscribers can be either coarse-grained (if they subscribe to the top-level event type):
-
- @DomainService
- public class SomeSubscriber {
-
- @Programmatic
- @com.google.common.eventbus.Subscribe
- public void on(ActionInteractionEvent ev) {
-
- ...
- }
-
- }
-
-or can be fine-grained by subscribing to specific event subtypes:
-
- @DomainService
- public class SomeSubscriber {
-
- @Programmatic
- @com.google.common.eventbus.Subscribe
- public void on(ToDoItem.CompletedEvent ev) {
-
- ...
- }
-
- }
-
-The subscriber's method is called (up to) 5 times:
-
-* whether to veto visibility (hide)
-* whether to veto usability (disable)
-* whether to veto execution (validate)
-* steps to perform prior to the action being invoked.
-* steps to perform after the action has been invoked.
-
-The subscriber can distinguish these by calling `ev.getPhase()`. Thus the general form is:
-
- @Programmatic
- @com.google.common.eventbus.Subscribe
- public void on(ActionInteractionEvent ev) {
-
- switch(ev.getPhase()) {
- case HIDE:
- ...
- break;
- case DISABLE:
- ...
- break;
- case VALIDATE:
- ...
- break;
- case EXECUTING:
- ...
- break;
- case EXECUTED:
- ...
- break;
- }
- }
-
-Vetoing is performed by calling the appropriate method on the event:
-
-* To hide:
-
- ev.hide()
-
-* To disable:
-
- ev.disable("...");
-
-* To invalidate:
-
- ev.invalidate("...");
-
-It is also possible to abort the transaction during the executing or executed
-phases by throwing an exception. If the exception is a subtype of `RecoverableException`
-then the exception will be rendered as a user-friendly warning (eg Growl/toast)
-rather than an error.
-
-
-## Raising events programmatically.
-
-Normally events are only raised for interactions through the UI. However, events can be raised programmatically by
-wrapping the target object using the [Wrapper Factory](../services/wrapper-factory.html) service.
+The `@ActionLayout` annotation applies to actions, collecting together all UI hints within a single
+annotation.
## See also
-Interaction events can also be raised for [properties](./PropertyInteraction.html) and [collections](./CollectionInteraction.html).
+Similar layout annotations exist for other elements of the metamodel:
+
+* [@ClassLayout](./ClassLayout.html) for domain classes
+* [@CollectionLayout](./CollectionLayout.html) for collections
+* [@PropertyLayout](./PropertyLayout.html) for properties
+* [@ParameterLayout](./ParameterLayout.html) for action parameters
Added: isis/site/trunk/content/reference/recognized-annotations/ClassLayout.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/reference/recognized-annotations/ClassLayout.md?rev=1643166&view=auto
==============================================================================
--- isis/site/trunk/content/reference/recognized-annotations/ClassLayout.md (added)
+++ isis/site/trunk/content/reference/recognized-annotations/ClassLayout.md Fri Dec 5 07:03:32 2014
@@ -0,0 +1,34 @@
+Title: @ClassLayout
+
+The `@ClassLayout` annotation applies to domain classes, collecting together all UI hints within a single
+annotation.
+
+* `cssClass` - the css class that a domain class (type) should have, to allow more targetted styling in `application.css`
+* `describedAs` - description of this class, eg to be rendered in a tooltip.
+* `named` -the name of this class (overriding the name derived from its name in code)
+* `paged` - the page size for instances of this class when rendered within a table.
+* `plural` - the plural name of the class
+
+
+For example:
+
+ @ClassLayout(
+ cssClass="x-key",
+ describedAs="Capture a task that you need to do",
+ paged=30)
+ )
+ public class ToDoItem {
+ ...
+ }
+
+
+## See also
+
+Similar layout annotations exist for other elements of the metamodel:
+
+* [@ActionLayout](./ActionLayout.html) for actions
+* [@CollectionLayout](./CollectionLayout.html) for collections
+* [@PropertyLayout](./PropertyLayout.html) for properties
+* [@ParameterLayout](./ParameterLayout.html) for action parameters
+
+
Added: 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=1643166&view=auto
==============================================================================
--- isis/site/trunk/content/reference/recognized-annotations/CollectionLayout.md (added)
+++ isis/site/trunk/content/reference/recognized-annotations/CollectionLayout.md Fri Dec 5 07:03:32 2014
@@ -0,0 +1,38 @@
+Title: @CollectionLayout
+
+The `@CollectionLayout` annotation applies to collections, collecting together all UI hints within a single
+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)
+* `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}
+
+For example:
+
+ public class ToDoItem {
+
+ @CollectionLayout(
+ cssClass="x-key",
+ describedAs="Other todo items that must be completed before this one",
+ labelPosition=LabelPosition.LEFT,
+ render=EAGERLY
+ typicalLength=80)
+ public SortedSet<ToDoItem> getDependencies() { ... }
+
+ ...
+ }
+
+## See also
+
+Similar layout annotations exist for other elements of the metamodel:
+
+* [@ActionLayout](./ActionLayout.html) for actions
+* [@ClassLayout](./ClassLayout.html) for domain classes
+* [@PropertyLayout](./PropertyLayout.html) for properties
+* [@ParameterLayout](./ParameterLayout.html) for action parameters
+
+
Copied: isis/site/trunk/content/reference/recognized-annotations/CssClass-deprecated.md (from r1633807, isis/site/trunk/content/reference/recognized-annotations/CssClass.md)
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/reference/recognized-annotations/CssClass-deprecated.md?p2=isis/site/trunk/content/reference/recognized-annotations/CssClass-deprecated.md&p1=isis/site/trunk/content/reference/recognized-annotations/CssClass.md&r1=1633807&r2=1643166&rev=1643166&view=diff
==============================================================================
--- isis/site/trunk/content/reference/recognized-annotations/CssClass.md (original)
+++ isis/site/trunk/content/reference/recognized-annotations/CssClass-deprecated.md Fri Dec 5 07:03:32 2014
@@ -1,5 +1,7 @@
Title: @CssClass
+> Deprecated in 1.8.0-SNAPSHOT, see instead [@ClassLayout](./ClassLayout.html), [@PropertyLayout](./PropertyLayout.html), [@CollectionLayout](./CollectionLayout.html), [@ActionLayout](./ActionLayout.html) and [@ParameterLayout](./ParameterLayout.html).
+
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.
@@ -50,6 +52,6 @@ Note that this (currently) only supports
## See also (1.8.0-SNAPSHOT)
-The similar [CssClassFa](./CssClassFa.html) annotation is also used as a hint
+The similar [CssClassFa](./CssClassFa-deprecated.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.
Copied: isis/site/trunk/content/reference/recognized-annotations/CssClassFa-deprecated.md (from r1633807, isis/site/trunk/content/reference/recognized-annotations/CssClassFa.md)
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/reference/recognized-annotations/CssClassFa-deprecated.md?p2=isis/site/trunk/content/reference/recognized-annotations/CssClassFa-deprecated.md&p1=isis/site/trunk/content/reference/recognized-annotations/CssClassFa.md&r1=1633807&r2=1643166&rev=1643166&view=diff
==============================================================================
--- isis/site/trunk/content/reference/recognized-annotations/CssClassFa.md (original)
+++ isis/site/trunk/content/reference/recognized-annotations/CssClassFa-deprecated.md Fri Dec 5 07:03:32 2014
@@ -1,5 +1,7 @@
Title: @CssClassFa (1.8.0-SNAPSHOT)
+> Deprecated in 1.8.0-SNAPSHOT, see instead [@ClassLayout](./ClassLayout.html), [@PropertyLayout](./PropertyLayout.html), [@CollectionLayout](./CollectionLayout.html), [@ActionLayout](./ActionLayout.html) and [@ParameterLayout](./ParameterLayout.html).
+
The `CssClassFa` annotation applies to objects and also to object actions,
and is used by the Wicket viewer as a UI hint.
@@ -64,7 +66,7 @@ Note that this (currently) only supports
## See also
-The similar [CssClass](./CssClass.html) annotation is also used as a hint
+The similar [CssClass](./CssClass-deprecated.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.
Copied: isis/site/trunk/content/reference/recognized-annotations/DescribedAs-deprecated.md (from r1630348, isis/site/trunk/content/reference/recognized-annotations/DescribedAs.md)
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/reference/recognized-annotations/DescribedAs-deprecated.md?p2=isis/site/trunk/content/reference/recognized-annotations/DescribedAs-deprecated.md&p1=isis/site/trunk/content/reference/recognized-annotations/DescribedAs.md&r1=1630348&r2=1643166&rev=1643166&view=diff
==============================================================================
--- isis/site/trunk/content/reference/recognized-annotations/DescribedAs.md (original)
+++ isis/site/trunk/content/reference/recognized-annotations/DescribedAs-deprecated.md Fri Dec 5 07:03:32 2014
@@ -1,5 +1,7 @@
Title: @DescribedAs
+> Deprecated in 1.8.0-SNAPSHOT, see instead [@ClassLayout](./ClassLayout.html), [@PropertyLayout](./PropertyLayout.html), [@CollectionLayout](./CollectionLayout.html), [@ActionLayout](./ActionLayout.html) and [@ParameterLayout](./ParameterLayout.html).
+
The `@DescribedAs` annotation is used to provide a short description of
something that features on the user interface. How this description is
used will depend upon the viewing mechanism - but it may be thought of
Modified: isis/site/trunk/content/reference/recognized-annotations/DomainService.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/reference/recognized-annotations/DomainService.md?rev=1643166&r1=1643165&r2=1643166&view=diff
==============================================================================
--- isis/site/trunk/content/reference/recognized-annotations/DomainService.md (original)
+++ isis/site/trunk/content/reference/recognized-annotations/DomainService.md Fri Dec 5 07:03:32 2014
@@ -1,4 +1,34 @@
Title: @DomainService
+Indicates that the (concrete) class should be automatically instantiated as a domain service, and specify a number of
+UI hints.
-> this is a stub
+Domain services with this annotation do NOT need to be registered explicitly in `isis.properties`; they will be
+discovered automatically on the CLASSPATH.
+
+The following attributes can be specified:
+
+* `menuBar` - the menubar in which the menu that hold's this service's actions should reside (1.8.0-SNAPSHOT)
+
+* `menuOrder` - the order of the service's menu with respect to other service's.
+
+* `repositoryFor` - if this domain service acts as a repository for an entity type, specify that entity type. (This is currently informational only)
+
+The `menuBar` can be set to PRIMARY, SECONDARY or TERTIARY. In the Wicket viewer the PRIMARY menu bar is left-aligned,
+the SECONDARY menu bar is right aligned, and the TERTIARY menu bar is associated with the user's name (far top-right).
+
+For example:
+
+ @DomainService(menuOrder = "10", repositoryFor = ToDoItem.class)
+ public class ToDoItems {
+ ...
+ }
+
+or:
+
+ @DomainService(menuBar = DomainService.MenuBar.SECONDARY, menuOrder = "1")
+ public class ToDoItemsFixturesService extends FixtureScripts {
+ ...
+ }
+
+It is not (currently) possible to specify the UI hints through any other means (specifically: is *not* supported through a `.layout.json` file).
\ No newline at end of file
Modified: isis/site/trunk/content/reference/recognized-annotations/Exploration-deprecated.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/reference/recognized-annotations/Exploration-deprecated.md?rev=1643166&r1=1643165&r2=1643166&view=diff
==============================================================================
--- isis/site/trunk/content/reference/recognized-annotations/Exploration-deprecated.md (original)
+++ isis/site/trunk/content/reference/recognized-annotations/Exploration-deprecated.md Fri Dec 5 07:03:32 2014
@@ -21,4 +21,4 @@ For example:
#### See also
-See also the [@Prototype](./Prototype.html) annotation.
+See also the [@Prototype](./Prototype-deprecated.html) annotation.
Copied: isis/site/trunk/content/reference/recognized-annotations/Hidden-deprecated.md (from r1630348, isis/site/trunk/content/reference/recognized-annotations/Hidden.md)
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/reference/recognized-annotations/Hidden-deprecated.md?p2=isis/site/trunk/content/reference/recognized-annotations/Hidden-deprecated.md&p1=isis/site/trunk/content/reference/recognized-annotations/Hidden.md&r1=1630348&r2=1643166&rev=1643166&view=diff
==============================================================================
--- isis/site/trunk/content/reference/recognized-annotations/Hidden.md (original)
+++ isis/site/trunk/content/reference/recognized-annotations/Hidden-deprecated.md Fri Dec 5 07:03:32 2014
@@ -1,8 +1,6 @@
Title: @Hidden
-> **Support**
->
-> * Fully supported by: Wicket viewer; other viewers do not yet support the `where` attribute.
+> Deprecated in 1.8.0-SNAPSHOT, see instead [@PropertyLayout](./PropertyLayout.html), [@CollectionLayout](./CollectionLayout.html), and [@ActionLayout](./ActionLayout.html).
The `@Hidden` annotation indicates that the member (property, collection
or action) to which it is applied should never be visible to the user.
Copied: isis/site/trunk/content/reference/recognized-annotations/MultiLine-deprecated.md (from r1630348, isis/site/trunk/content/reference/recognized-annotations/MultiLine.md)
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/reference/recognized-annotations/MultiLine-deprecated.md?p2=isis/site/trunk/content/reference/recognized-annotations/MultiLine-deprecated.md&p1=isis/site/trunk/content/reference/recognized-annotations/MultiLine.md&r1=1630348&r2=1643166&rev=1643166&view=diff
==============================================================================
--- isis/site/trunk/content/reference/recognized-annotations/MultiLine.md (original)
+++ isis/site/trunk/content/reference/recognized-annotations/MultiLine-deprecated.md Fri Dec 5 07:03:32 2014
@@ -1,5 +1,7 @@
Title: @MultiLine
+> Deprecated in 1.8.0-SNAPSHOT, see instead [@PropertyLayout](./PropertyLayout.html) and [@ParameterLayout](./ParameterLayout.html).
+
> **Support**
>
> Supported, though the Wicket viewer does not support the `preventWrapping` attribute.
Copied: isis/site/trunk/content/reference/recognized-annotations/Named-deprecated.md (from r1630348, isis/site/trunk/content/reference/recognized-annotations/Named.md)
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/reference/recognized-annotations/Named-deprecated.md?p2=isis/site/trunk/content/reference/recognized-annotations/Named-deprecated.md&p1=isis/site/trunk/content/reference/recognized-annotations/Named.md&r1=1630348&r2=1643166&rev=1643166&view=diff
==============================================================================
--- isis/site/trunk/content/reference/recognized-annotations/Named.md (original)
+++ isis/site/trunk/content/reference/recognized-annotations/Named-deprecated.md Fri Dec 5 07:03:32 2014
@@ -1,5 +1,7 @@
Title: @Named
+> Deprecated in 1.8.0-SNAPSHOT, see instead [@ClassLayout](./ClassLayout.html), [@PropertyLayout](./PropertyLayout.html), [@CollectionLayout](./CollectionLayout.html), [@ActionLayout](./ActionLayout.html) and [@ParameterLayout](./ParameterLayout.html).
+
The `@Named` annotation is used when you want to specify the way
something is named on the user interface i.e. when you do not want to
use the name generated automatically by the system. It can be applied to
Copied: isis/site/trunk/content/reference/recognized-annotations/Paged-deprecated.md (from r1630348, isis/site/trunk/content/reference/recognized-annotations/Paged.md)
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/reference/recognized-annotations/Paged-deprecated.md?p2=isis/site/trunk/content/reference/recognized-annotations/Paged-deprecated.md&p1=isis/site/trunk/content/reference/recognized-annotations/Paged.md&r1=1630348&r2=1643166&rev=1643166&view=diff
==============================================================================
--- isis/site/trunk/content/reference/recognized-annotations/Paged.md (original)
+++ isis/site/trunk/content/reference/recognized-annotations/Paged-deprecated.md Fri Dec 5 07:03:32 2014
@@ -1,8 +1,6 @@
Title: @Paged
-> **Support**
->
-> * Supported by: Wicket viewer; not yet supported by other viewers.
+> Deprecated in 1.8.0-SNAPSHOT, see instead [@CollectionLayout](./CollectionLayout.html).
This annotation is used to indicate that parented and/or standalone
collections should be paginated.
Added: 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=1643166&view=auto
==============================================================================
--- isis/site/trunk/content/reference/recognized-annotations/ParameterLayout.md (added)
+++ isis/site/trunk/content/reference/recognized-annotations/ParameterLayout.md Fri Dec 5 07:03:32 2014
@@ -0,0 +1,75 @@
+Title: @ParameterLayout (1.8.0-SNAPSHOT)
+
+The `@ParameterLayout` annotation applies to action parameters, collecting together all UI hints within a single
+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)
+* `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.
+* `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
+
+For example:
+
+ public class ToDoItem {
+
+ public ToDoItem updateDescription(
+ @ParameterLayout(
+ cssClass="x-key",
+ describedAs="What needs to be done",
+ labelPosition=LabelPosition.LEFT,
+ named="Description",
+ typicalLength=80)
+ final String description) {
+ setDescription(description);
+ return this;
+ }
+
+ public ToDoItem updateNotes(
+ @ParameterLayout(
+ describedAs="Additional notes",
+ labelPosition=LabelPosition.TOP,
+ named="Notes",
+ multiLine=8)
+ final String notes) {
+ setNotes(notes);
+ return this;
+ }
+
+ ...
+ }
+
+
+
+## Alternatives (`.layout.json`)
+
+Unlike [properties](./PropertyLayout.html), it (currently) isn't possible to specify layout hints for action parameters using the `.layout.json` file.
+
+
+## Specifying a default setting
+
+If you want a consistent look-n-feel throughout the app, eg all action parameter labels to the top, then it'd be rather frustrating to have to annotate every property.
+
+Instead, a default can be specified in `isis.properties`:
+
+ isis.viewers.parameterLayout.labelPosition=TOP
+
+or
+
+ isis.viewers.parameterLayout.labelPosition=LEFT
+
+If these are not present then Isis will render according to internal defaults. At the time of writing, this means labels are to the left for all datatypes except multiline strings.
+
+
+## See also
+
+Similar layout annotations exist for other elements of the metamodel:
+
+* [@ActionLayout](./ActionLayout.html) for actions
+* [@ClassLayout](./ClassLayout.html) for domain classes
+* [@CollectionLayout](./CollectionLayout.html) for collections
+* [@PropertyLayout](./PropertyLayout.html) for properties
+
+
Copied: isis/site/trunk/content/reference/recognized-annotations/Plural-deprecated.md (from r1630348, isis/site/trunk/content/reference/recognized-annotations/Plural.md)
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/reference/recognized-annotations/Plural-deprecated.md?p2=isis/site/trunk/content/reference/recognized-annotations/Plural-deprecated.md&p1=isis/site/trunk/content/reference/recognized-annotations/Plural.md&r1=1630348&r2=1643166&rev=1643166&view=diff
==============================================================================
--- isis/site/trunk/content/reference/recognized-annotations/Plural.md (original)
+++ isis/site/trunk/content/reference/recognized-annotations/Plural-deprecated.md Fri Dec 5 07:03:32 2014
@@ -1,8 +1,6 @@
Title: @Plural
-> **Support**
->
-> * Not supported by: Wicket viewer
+> Deprecated in 1.8.0-SNAPSHOT, see instead [@ClassLayout](./ClassLayout.html).
When the framework displays a collection of several objects it may use
the plural form of the object type in the title. By default the plural
Copied: isis/site/trunk/content/reference/recognized-annotations/PropertyLayout.md (from r1634037, isis/site/trunk/content/reference/recognized-annotations/LabelAt.md)
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/reference/recognized-annotations/PropertyLayout.md?p2=isis/site/trunk/content/reference/recognized-annotations/PropertyLayout.md&p1=isis/site/trunk/content/reference/recognized-annotations/LabelAt.md&r1=1634037&r2=1643166&rev=1643166&view=diff
==============================================================================
--- isis/site/trunk/content/reference/recognized-annotations/LabelAt.md (original)
+++ isis/site/trunk/content/reference/recognized-annotations/PropertyLayout.md Fri Dec 5 07:03:32 2014
@@ -1,24 +1,41 @@
-Title: @LabelAt (1.8.0-SNAPSHOT)
+Title: @PropertyLayout (1.8.0-SNAPSHOT)
-The `@LabelAt` annotation is a UI hint to indicate the positioning of a
-property or action parameter label either to the top or the left.
+The `@PropertyLayout` annotation applies to properties, collecting together all UI hints within a single
+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)
+* `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)
+* `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
For example:
public class ToDoItem {
- @LabelAt(Position.LEFT)
+ @PropertyLayout(
+ cssClass="x-key",
+ describedAs="What needs to be done",
+ labelPosition=LabelPosition.LEFT,
+ typicalLength=80)
public String getDescription() { ... }
- @LabelAt(Position.TOP)
+ @PropertyLayout(
+ describedAs="Additional notes",
+ labelPosition=LabelPosition.TOP,
+ multiLine=8)
public String getNotes() { ... }
...
}
+
## Alternatives (`.layout.json`)
-As an alternative to using the `@LabelAt` annotation, the `.layout.json`
+As an alternative to using the `@PropertyLayout` annotation, the `.layout.json`
[dynamic layout file](../../components/viewers/wicket/dynamic-layouts.html)
can be specified, eg:
@@ -28,9 +45,19 @@ can be specified, eg:
"Other": {
"members": {
...
+ "description": {
+ "propertyLayout": {
+ "cssClass": "x-key",
+ "describedAs": "What needs to be done",
+ "labelPosition": "LEFT",
+ "typicalLength": 80
+ }
+ },
"notes": {
- "labelAt": {
- "value": "TOP"
+ "propertyLayout": {
+ "describedAs": "Additional notes"
+ "labelPosition": "TOP",
+ multiLine=8
}
},
....
@@ -40,21 +67,27 @@ can be specified, eg:
}
}
-Note that it (currently) isn't possible to specify layout hints for action parameters.
+## Specifying a default setting for label positions
-## Specifying a default setting
+If you want a consistent look-n-feel throughout the app, eg all property labels to the top, then it'd be rather
+frustrating to have to annotate every property.
-If you want a consistent look-n-feel throughout the app (eg all property labels to the top,
-or all action action parameters to the left) then it'd be rather frustrating to have to
-annotate every property and action parameter.
+Instead, a default can be specified in `isis.properties`:
-Instead, two configuration settings can be specified (in `isis.properties`):
-
- isis.viewers.labelAt.property=TOP
+ isis.viewers.propertyLayout.labelPosition=TOP
or
- isis.viewers.labelAt.parameter=LEFT
+ isis.viewers.propertyLayout.labelPosition=LEFT
+
+If these are not present then Isis will render according to internal defaults. At the time of writing, this means labels are to the left for all datatypes except multiline strings.
+
+## See also
+
+Similar layout annotations exist for other elements of the metamodel:
-If these are not present then Isis will render according to internal defaults. At the time of writing, this means labels are to the left for all datatypes except multiline strings.
\ No newline at end of file
+* [@ActionLayout](./ActionLayout.html) for actions
+* [@ClassLayout](./ClassLayout.html) for domain classes
+* [@CollectionLayout](./CollectionLayout.html) for collections
+* [@ParameterLayout](./ParameterLayout.html) for action parameters
Copied: isis/site/trunk/content/reference/recognized-annotations/Prototype-deprecated.md (from r1630348, isis/site/trunk/content/reference/recognized-annotations/Prototype.md)
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/reference/recognized-annotations/Prototype-deprecated.md?p2=isis/site/trunk/content/reference/recognized-annotations/Prototype-deprecated.md&p1=isis/site/trunk/content/reference/recognized-annotations/Prototype.md&r1=1630348&r2=1643166&rev=1643166&view=diff
==============================================================================
--- isis/site/trunk/content/reference/recognized-annotations/Prototype.md (original)
+++ isis/site/trunk/content/reference/recognized-annotations/Prototype-deprecated.md Fri Dec 5 07:03:32 2014
@@ -1,8 +1,6 @@
Title: @Prototype
-> **Support**
->
-> * Partly supported by: Wicket viewer (equating to Wicket's DEVELOPMENT mode)
+> Deprecated in 1.8.0-SNAPSHOT, see instead [@ActionLayout](./ActionLayout.html)
The `@Prototype` annotation marks an action method as available in
prototype mode only, and therefore not intended for use in the
Modified: isis/site/trunk/content/reference/recognized-annotations/Render.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/reference/recognized-annotations/Render.md?rev=1643166&r1=1643165&r2=1643166&view=diff
==============================================================================
--- isis/site/trunk/content/reference/recognized-annotations/Render.md (original)
+++ isis/site/trunk/content/reference/recognized-annotations/Render.md Fri Dec 5 07:03:32 2014
@@ -1,8 +1,6 @@
Title: @Render
-> **Support**
->
-> * Supported by: Wicket viewer; not yet supported by other viewers.
+> Deprecated in 1.8.0-SNAPSHOT, see instead [@CollectionLayout](./CollectionLayout.html)
The `@Render` annotation is a hint for properties and collections to
indicate that a value property should be rendered lazily (rather than
Copied: isis/site/trunk/content/reference/recognized-annotations/SortedBy-deprecated.md (from r1630348, isis/site/trunk/content/reference/recognized-annotations/SortedBy.md)
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/reference/recognized-annotations/SortedBy-deprecated.md?p2=isis/site/trunk/content/reference/recognized-annotations/SortedBy-deprecated.md&p1=isis/site/trunk/content/reference/recognized-annotations/SortedBy.md&r1=1630348&r2=1643166&rev=1643166&view=diff
==============================================================================
--- isis/site/trunk/content/reference/recognized-annotations/SortedBy.md (original)
+++ isis/site/trunk/content/reference/recognized-annotations/SortedBy-deprecated.md Fri Dec 5 07:03:32 2014
@@ -1,6 +1,6 @@
Title: @SortedBy
-> Supported by: Wicket viewer; not yet supported by other viewers.
+> Deprecated in 1.8.0-SNAPSHOT, see instead [@CollectionLayout](./CollectionLayout.html).
The `@SortedBy` annotation is an instruction hint for (`SortedSet`) collections to use the specified comparator rather than the natural ordering of the entity
(as would usually be the case).
Modified: isis/site/trunk/content/reference/recognized-annotations/TypicalLength.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/reference/recognized-annotations/TypicalLength.md?rev=1643166&r1=1643165&r2=1643166&view=diff
==============================================================================
--- isis/site/trunk/content/reference/recognized-annotations/TypicalLength.md (original)
+++ isis/site/trunk/content/reference/recognized-annotations/TypicalLength.md Fri Dec 5 07:03:32 2014
@@ -1,5 +1,7 @@
Title: @TypicalLength
+> Deprecated in 1.8.0-SNAPSHOT, see instead [@PropertyLayout](./PropertyLayout.html) and [@ParameterLayout](./ParameterLayout.html).
+
The `@TypicalLength` annotation indicates the typical length of a
`String` property or `String` parameter in an action. It can also be
specified for string-based value types.
Modified: isis/site/trunk/content/reference/recognized-annotations/ViewModel.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/reference/recognized-annotations/ViewModel.md?rev=1643166&r1=1643165&r2=1643166&view=diff
==============================================================================
--- isis/site/trunk/content/reference/recognized-annotations/ViewModel.md (original)
+++ isis/site/trunk/content/reference/recognized-annotations/ViewModel.md Fri Dec 5 07:03:32 2014
@@ -24,7 +24,7 @@ View models must have a no-arg construct
> Note that there is a `DomainObjectContainer#newViewModelInstance(.)`; this is for view models that implement `ViewModel` interface and can be safely ignored.
>
-The view model's memento will be derived from the value of the view model object's properties. Any [@NotPersistent](http://isis.apache.org/reference/recognized-annotations/NotPersistent.html) properties will be excluded from the memento, as will any [@Programmatic](http://isis.apache.org/reference/recognized-annotations/Programmatic.html) properties. Properties that are merely [@Hidden](http://isis.apache.org/reference/recognized-annotations/Hidden.html) are included in the memento.
+The view model's memento will be derived from the value of the view model object's properties. Any [@NotPersistent](http://isis.apache.org/reference/recognized-annotations/NotPersistent.html) properties will be excluded from the memento, as will any [@Programmatic](http://isis.apache.org/reference/recognized-annotations/Programmatic.html) properties. Properties that are merely [@Hidden](http://isis.apache.org/reference/recognized-annotations/Hidden-deprecated.html) are included in the memento.
Only properties supported by the configured [MementoService](../reference/services/memento-service.html) can be used. The default implementation supports all the value types and persisted entities.
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=1643166&r1=1643165&r2=1643166&view=diff
==============================================================================
--- isis/site/trunk/content/reference/recognized-annotations/about.md (original)
+++ isis/site/trunk/content/reference/recognized-annotations/about.md Fri Dec 5 07:03:32 2014
@@ -8,62 +8,47 @@ go back to: [documentation](../../docume
<th>Layer</th>
<th>Purpose</th>
<th><a href="../../components/viewers/wicket/dynamic-layouts.html">.layout.json</a> ?</th>
- <th>Deprecated?</th>
</tr>
<tr>
<td><a href="./ActionInteraction.html">@ActionInteraction</a></td>
<td>Domain</td>
- <td>Enable subscribers to either veto, validate or take further steps before/after an action has been invoked.
- </td>
- <td></td>
+ <td>Enable subscribers to either veto, validate or take further steps before/after an action has been invoked.</td>
<td></td>
</tr>
<tr>
- <td><a href="./ActionOrder-deprecated.html" style="text-decoration: line-through;" >@ActionOrder</a></td>
+ <td><a href="./ActionLayout.html">@ActionLayout</a></td>
<td>UI</td>
- <td>Order of buttons and menu items representing actions.
- </td>
+ <td>User interface hints for actions</td>
<td></td>
- <td>Y</td>
</tr>
<tr>
<td><a href="./ActionSemantics.html">@ActionSemantics</a></td>
<td>Domain</td>
- <td>Query-only, idempotent or non-idempotent.
- </td>
- <td></td>
+ <td>Query-only, idempotent or non-idempotent.</td>
<td></td>
</tr>
<tr>
<td><a href="./Aggregated.html">@Aggregated</a></td>
<td>Domain, Persistence</td>
- <td>Part of an aggregate root (only partly supported)
- </td>
- <td></td>
+ <td>Part of an aggregate root (only partly supported)</td>
<td></td>
</tr>
<tr>
<td><a href="./Audited.html">@Audited</a></td>
<td>Domain</td>
- <td>Audit changes to an object
- </td>
- <td></td>
+ <td>Audit changes to an object</td>
<td></td>
</tr>
<tr>
<td><a href="./AutoComplete.html">@AutoComplete</a></td>
<td>UI</td>
- <td>Repository method to search for entities
- </td>
- <td></td>
+ <td>Repository method to search for entities</td>
<td></td>
</tr>
<tr>
<td><a href="./Bookmarkable.html">@Bookmarkable</a></td>
<td>UI</td>
- <td>Whether (and how) to create a bookmark for visited object.
- </td>
- <td></td>
+ <td>Whether (and how) to create a bookmark for visited object.</td>
<td></td>
</tr>
<tr>
@@ -78,92 +63,59 @@ go back to: [documentation](../../docume
<tr>
<td><a href="./Bulk.html">@Bulk</a></td>
<td>UI, Domain</td>
- <td>Indicates an action is a bulk action, can be applied to multiple instances.
- </td>
- <td></td>
+ <td>Indicates an action is a bulk action, can be applied to multiple instances.</td>
<td></td>
</tr>
<tr>
- <td><a href="./CollectionInteraction.html">@CollectionInteraction</a></td>
- <td>Domain</td>
- <td>Enable subscribers to either veto, validate or take further steps before/after a collection has been added to or
- removed from.
- </td>
- <td></td>
+ <td><a href="./ClassLayout.html">@ClassLayout</a></td>
+ <td>UI</td>
+ <td>User interface hints for domain classes</td>
<td></td>
</tr>
<tr>
- <td><a href="./Command.html">@Command</a></td>
+ <td><a href="./CollectionInteraction.html">@CollectionInteraction</a></td>
<td>Domain</td>
- <td>Action invocation should be reified as a command object, optionally persistable for profiling and enhanced
- auditing, and background/async support.
- </td>
- <td></td>
- <td></td>
- </tr>
- <tr>
- <td><a href="./CssClass.html">@CssClass</a></td>
- <td>UI</td>
- <td>Allow visual representation of individual objects or object members layout to be customized by application-specific CSS.
- </td>
- <td>Y</td>
+ <td>Enable subscribers to either veto, validate or take further steps before/after a collection has been added to or
+ removed from.</td>
<td></td>
</tr>
<tr>
- <td><a href="./CssClassFa.html">@CssClassFa</a></td>
+ <td><a href="./CollectionLayout.html">@CollectionLayout</a></td>
<td>UI</td>
- <td>So that font awesome icons can be applied to action buttons/menu items and optionally as an object icon.
- </td>
- <td>Y</td>
+ <td>User interface hints for collections</td>
<td></td>
</tr>
<tr>
- <td><a href="./Debug-deprecated.html" style="text-decoration: line-through;" >@Debug</a></td>
- <td>UI</td>
- <td>Action only invocable in debug mode.
- </td>
+ <td><a href="./Command.html">@Command</a></td>
+ <td>Domain</td>
+ <td>Action invocation should be reified as a command object, optionally persistable for profiling and enhanced
+ auditing, and background/async support.</td>
<td></td>
- <td>Y</td>
</tr>
<tr>
<td><a href="./Defaulted.html">@Defaulted</a></td>
<td>Domain</td>
- <td>Indicates that a (value) class has a default value.
- </td>
- <td></td>
- <td></td>
- </tr>
- <tr>
- <td><a href="./DescribedAs.html">@DescribedAs</a></td>
- <td>UI</td>
- <td>Provide a longer description/tool-tip of an object or object member.
- </td>
- <td>Y</td>
+ <td>Indicates that a (value) class has a default value.</td>
<td></td>
</tr>
<tr>
<td><a href="./Digits.html">@javax.validation.constraints.Digits</a></td>
<td>Domain</td>
- <td>Precision/scale for BigDecimal values.
- </td>
- <td></td>
+ <td>Precision/scale for BigDecimal values.</td>
<td></td>
</tr>
<tr>
<td><a href="./Disabled.html">@Disabled</a></td>
<td>UI, Domain</td>
<td>Object property cannot be edited, an object collection cannot be added to/removed from, or an
- object action cannot be invoked.
- </td>
+ object action cannot be invoked.</td>
<td>Y</td>
- <td></td>
</tr>
<tr>
<td><a href="./DomainService.html">@DomainService</a></td>
<td>Domain</td>
<td>Class is a domain service (rather than an entity or view model)</td>
<td></td>
- <td></td>
</tr>
<tr>
<td><a href="./Encodable.html">@Encodable</a></td>
@@ -171,23 +123,12 @@ go back to: [documentation](../../docume
<td>Indicates that a (value) class can be serialized/encoded.
</td>
<td></td>
- <td></td>
</tr>
<tr>
<td><a href="./EqualByContent.html">@EqualByContent</a></td>
<td>Domain</td>
- <td>Indicates that a value class has equality semantics.
- </td>
- <td></td>
- <td></td>
- </tr>
- <tr>
- <td><a href="./Exploration-deprecated.html" style="text-decoration: line-through;" >@Exploration</a></td>
- <td>UI</td>
- <td>Action available in special 'exploration' mode.
- </td>
+ <td>Indicates that a value class has equality semantics.</td>
<td></td>
- <td>Y</td>
</tr>
<tr>
<td><a href="./Facets.html">@Facets</a></td>
@@ -195,48 +136,13 @@ go back to: [documentation](../../docume
<td>Install arbitrary facets within the Isis metamodel.
</td>
<td></td>
- <td></td>
- </tr>
- <tr>
- <td><a href="./FieldOrder-deprecated.html" style="text-decoration: line-through;" >@FieldOrder</a></td>
- <td>UI</td>
- <td>Order of properties and collections
- </td>
- <td></td>
- <td>Y</td>
- </tr>
- <tr>
- <td><a href="./Hidden.html">@Hidden</a></td>
- <td>UI, Domain</td>
- <td>Object member is not visible.
- </td>
- <td>Y</td>
- <td></td>
</tr>
<tr>
<td><a href="./HomePage.html">@HomePage</a></td>
<td>UI</td>
<td>Query-only action (on domain service) to be invoked, result of which is
- rendered as the user's home page.
- </td>
- <td></td>
- <td></td>
- </tr>
- <tr>
- <td><a href="./Idempotent-deprecated.html" style="text-decoration: line-through;" >@Idempotent</a></td>
- <td>Domain</td>
- <td>Replaced by @ActionSemantics.
- </td>
- <td></td>
- <td>Y</td>
- </tr>
- <tr>
- <td><a href="./Ignore-deprecated.html" style="text-decoration: line-through;" >@Ignore</a></td>
- <td>Domain</td>
- <td>Replaced by @Programmatic.
- </td>
+ rendered as the user's home page.</td>
<td></td>
- <td>Y</td>
</tr>
<tr>
<td><a href="./Immutable.html">@Immutable</a></td>
@@ -245,7 +151,6 @@ go back to: [documentation](../../docume
from). Actions <i>can</i> still be invoked.
</td>
<td></td>
- <td></td>
</tr>
<tr>
<td><a href="./Inject.html">@javax.inject.Inject</a></td>
@@ -253,56 +158,37 @@ go back to: [documentation](../../docume
<td>Inject domain service into a domain object (entity or view model) or another domain service.
</td>
<td></td>
- <td></td>
</tr>
<tr>
- <td><a href="./Mask.html">@Mask</a></td>
- <td>UI/domain</td>
- <td>How to parse/render values (not properly supported)
- </td>
- <td></td>
+ <td><a href="./PropertyLayout.html">@PropertyLayout</a></td>
+ <td>UI</td>
+ <td>Layout hints for a property (currently: its label position either to top or the left).</td>
<td></td>
</tr>
<tr>
- <td><a href="./LabelAt.html">@LabelAt</a></td>
+ <td><a href="./ParameterLayout.html">@PropertyLayout</a></td>
<td>UI</td>
- <td>Positioning of property or action parmaeter label either to top or the left.
- </td>
- <td></td>
+ <td>Layout hints for an action parameter (currently: its label position either to top or the left).</td>
<td></td>
</tr>
<tr>
<td><a href="./MaxLength.html">@MaxLength</a></td>
<td>Domain</td>
- <td>Maximum length of a property value (strings).
- </td>
- <td></td>
+ <td>Maximum length of a property value (strings).</td>
<td></td>
</tr>
<tr>
<td><a href="./MemberGroupLayout.html">@MemberGroupLayout</a></td>
<td>UI</td>
- <td>Grouping of properties into groups, and organizing of properties, collections into columns.
- </td>
- <td>Y</td>
- <td></td>
- </tr>
- <tr>
- <td><a href="./MemberGroups.html">@MemberGroups</a></td>
- <td>UI</td>
- <td>Replaced by @MemberGroupLayout
- </td>
+ <td>Grouping of properties into groups, and organizing of properties, collections into columns.</td>
<td>Y</td>
- <td></td>
</tr>
<tr>
<td><a href="./MemberOrder.html">@MemberOrder</a></td>
<td>UI</td>
<td>Ordering of properties, collections and actions, and also associating actions with either a property or a
- collection.
- </td>
+ collection.</td>
<td>Y</td>
- <td></td>
</tr>
<tr>
<td><a href="./MinLength.html">@MinLength</a></td>
@@ -310,30 +196,11 @@ go back to: [documentation](../../docume
<td>Minimum number of characters required for an auto-complete search argument.
</td>
<td></td>
- <td></td>
- </tr>
- <tr>
- <td><a href="./MultiLine.html">@MultiLine</a></td>
- <td>UI</td>
- <td>Render string property over multiple lines (a textarea rather than a textbox)
- </td>
- <td>Y</td>
- <td></td>
</tr>
<tr>
<td><a href="./MustSatisfy.html">@MustSatisfy</a></td>
<td>Domain</td>
- <td>Specify arbitrary specification constraints on a class member, action parameter or object.
- </td>
- <td></td>
- <td></td>
- </tr>
- <tr>
- <td><a href="./Named.html">@Named</a></td>
- <td>UI</td>
- <td>Override name inferred from class. Required for parameter names (prior to Java8)
- </td>
- <td>Y</td>
+ <td>Specify arbitrary specification constraints on a class member, action parameter or object.</td>
<td></td>
</tr>
<tr>
@@ -341,222 +208,305 @@ go back to: [documentation](../../docume
<td>UI</td>
<td>Indicates that a domain service action is not rendered as an action on the (entity) types of its
parameters. For 1-arg query-only actions, controls whether the domain service action is rendered as a property
- or collection on the entity type of its parameter.
- </td>
- <td></td>
+ or collection on the entity type of its parameter.</td>
<td></td>
</tr>
<tr>
<td><a href="./NotInServiceMenu.html">@NotInServiceMenu</a></td>
<td>UI</td>
<td>Indicates that a domain service should not be rendered in the application menu (at top of page in
- Wicket viewer).
- </td>
- <td></td>
+ Wicket viewer).</td>
<td></td>
</tr>
<tr>
<td><a href="./NotPersistable.html">@NotPersistable</a></td>
<td>Domain, Persistence</td>
- <td>Indicates that a domain object may not be programmatically persisted (partly supported).
- </td>
- <td></td>
+ <td>Indicates that a domain object may not be programmatically persisted (partly supported).</td>
<td></td>
</tr>
<tr>
<td><a href="./NotPersisted.html">@NotPersisted</a></td>
<td>Domain, Persistence</td>
- <td>Indicates that an object property is derived, is not persisted.
- </td>
- <td></td>
+ <td>Indicates that an object property is derived, is not persisted.</td>
<td></td>
</tr>
<tr>
<td><a href="./ObjectType.html">@ObjectType</a></td>
<td>Domain</td>
<td>For constructing the external identifier (URI) of an entity instance (part of its URL in both Wicket viewer and
- Restful Objects viewer).
- </td>
- <td></td>
+ Restful Objects viewer).</td>
<td></td>
</tr>
<tr>
<td><a href="./Optional.html">@Optional</a></td>
<td>Domain</td>
- <td>Specifies that a property or action parameter is not mandatory.
- </td>
- <td></td>
- <td></td>
- </tr>
- <tr>
- <td><a href="./Paged.html">@Paged</a></td>
- <td>UI</td>
- <td>Number of instances to display in tables representing (parented or standalone) collections.
- </td>
- <td></td>
+ <td>Specifies that a property or action parameter is not mandatory.</td>
<td></td>
</tr>
<tr>
<td><a href="./Parseable.html">@Parseable</a></td>
<td>UI/domain</td>
- <td>Indicates that a (value) class can be reconstructed from a string.
- </td>
- <td></td>
+ <td>Indicates that a (value) class can be reconstructed from a string.</td>
<td></td>
</tr>
<tr>
- <td><a href="./Plural.html">@Plural</a></td>
- <td>UI</td>
- <td>For the irregular plural form of an entity type.
- </td>
- <td></td>
+ <td><a href="./PropertyInteraction.html">@PropertyInteraction</a></td>
+ <td>Domain</td>
+ <td>Enable subscribers to either veto, validate or take further steps before/after a property has been modified or
+ cleared.</td>
<td></td>
</tr>
<tr>
- <td><a href="./PostsPropertyChangedEvent-deprecated.html" style="text-decoration: line-through;" >@PostsPropertyChangedEvent</a></td>
+ <td><a href="./Programmatic.html">@Programmatic</a></td>
<td>Domain</td>
- <td>Replaced by @PropertyInteraction
- </td>
+ <td>Ignore a public method, excluded from the Isis metamodel.</td>
<td></td>
- <td>Y</td>
</tr>
<tr>
- <td><a href="./PropertyInteraction.html">@PropertyInteraction</a></td>
+ <td><a href="./PublishedAction.html">@PublishedAction</a></td>
<td>Domain</td>
- <td>Enable subscribers to either veto, validate or take further steps before/after a property has been modified or
- cleared.
- </td>
+ <td>Action invocation should be serialized and published by configured PublishingService (if any), eg to other
+ systems.</td>
<td></td>
+ </tr>
+ <tr>
+ <td><a href="./PublishedObject.html">@PublishedObject</a></td>
+ <td>Domain</td>
+ <td>Change to object should be serialized and published by configured PublishingService (if any), eg to other
+ systems.</td>
<td></td>
</tr>
<tr>
- <td><a href="./Programmatic.html">@Programmatic</a></td>
+ <td><a href="./RegEx.html">@RegEx</a></td>
<td>Domain</td>
- <td>Ignore a public method, excluded from the Isis metamodel.
- </td>
+ <td>Validate change to value of string property.</td>
<td></td>
+ </tr>
+ <tr>
+ <td><a href="./RequestScoped.html">@RequestScoped</a></td>
+ <td>Domain</td>
+ <td>Specify that a domain service has request-scope (rather than a singleton). (In <code>javax.enterprise.context</code> package).</td>
<td></td>
</tr>
<tr>
- <td><a href="./Prototype.html">@Prototype</a></td>
+ <td><a href="./Title.html">@Title</a></td>
<td>UI</td>
- <td>Indicates that an action should only be visible in 'prototype' mode.
+ <td>Indicates which of the object's properties should be used to build up a title for the object.
</td>
<td></td>
- <td></td>
</tr>
<tr>
- <td><a href="./PublishedAction.html">@PublishedAction</a></td>
+ <td><a href="./TypeOf.html">@TypeOf</a></td>
<td>Domain</td>
- <td>Action invocation should be serialized and published by configured PublishingService (if any), eg to other
- systems.
+ <td>The type of entity stored within a collection (if cannot be otherwise inferred, eg from generics).
</td>
<td></td>
- <td></td>
</tr>
<tr>
- <td><a href="./PublishedObject.html">@PublishedObject</a></td>
+ <td><a href="./Value.html">@Value</a></td>
<td>Domain</td>
- <td>Change to object should be serialized and published by configured PublishingService (if any), eg to other
- systems.
+ <td>Specify that a class has value-semantics.
</td>
<td></td>
<td></td>
</tr>
<tr>
- <td><a href="./QueryOnly-deprecated.html" style="text-decoration: line-through;" >@QueryOnly</a></td>
- <td>Domain</td>
- <td>Replaced by @ActionSemantics.
+ <td><a href="./ViewModel.html">@ViewModel</a></td>
+ <td>Domain, Persistence</td>
+ <td>Specify that a class is a view model (as opposed to an entity or domain service).
</td>
<td></td>
- <td>Y</td>
+ <td></td>
</tr>
+</table>
+
+
+## Deprecated Annotations (1.8.0-SNAPSHOT)
+
+<table class="table table-bordered table-condensed table-hover">
<tr>
- <td><a href="./RegEx.html">@RegEx</a></td>
- <td>Domain</td>
- <td>Validate change to value of string property.
+ <th>Annotation</th>
+ <th>Layer</th>
+ <th>Purpose</th>
+ <th><a href="../../components/viewers/wicket/dynamic-layouts.html">.layout.json</a> ?</th>
+ </tr>
+ <tr>
+ <td><a href="./ActionOrder-deprecated.html" style="text-decoration: line-through;" >@ActionOrder</a></td>
+ <td>UI</td>
+ <td>Order of buttons and menu items representing actions.
</td>
<td></td>
- <td></td>
</tr>
<tr>
- <td><a href="./Render.html">@Render</a></td>
+ <td><a href="./CssClass-deprecated.html">@CssClass</a></td>
<td>UI</td>
- <td>Eagerly (or lazily) render the contents of a collection.
+ <td>Allow visual representation of individual objects or object members layout to be customized by application-specific CSS.
+ <br/>Deprecated in 1.8.0-SNAPSHOT, see <code>@ClassLayout</code>, <code>@PropertyLayout</code>, <code>@CollectionLayout</code>, <code>@ActionLayout</code> and <code>@ParameterLayout</code>
</td>
- <td></td>
- <td></td>
+ <td>Y</td>
</tr>
<tr>
- <td><a href="./RenderedAsDayBefore.html">@RenderedAsDayBefore</a></td>
+ <td><a href="./CssClassFa-deprecated.html">@CssClassFa</a></td>
<td>UI</td>
- <td>Render dates as the day before; ie store [a,b) internally but render [a,b-1]) to end-user.
+ <td>So that font awesome icons can be applied to action buttons/menu items and optionally as an object icon.
+ <br/>Deprecated in 1.8.0-SNAPSHOT, see <code>@ActionLayout</code>
</td>
- <td></td>
- <td></td>
+ <td>Y</td>
</tr>
<tr>
- <td><a href="./RequestScoped.html">@RequestScoped</a></td>
- <td>Domain</td>
- <td>Specify that a domain service has request-scope (rather than a singleton). (In <code>javax.enterprise.context</code> package).
+ <td><a href="./Debug-deprecated.html" style="text-decoration: line-through;" >@Debug</a></td>
+ <td>UI</td>
+ <td>Action only invocable in debug mode.
</td>
<td></td>
- <td></td>
</tr>
<tr>
- <td><a href="./Resolve-deprecated.html" style="text-decoration: line-through;" >@Resolve</a></td>
+ <td><a href="./DescribedAs-deprecated.html">@DescribedAs</a></td>
<td>UI</td>
- <td>Replaced by @Render.
+ <td>Provide a longer description/tool-tip of an object or object member.
+ <br/>Deprecated in 1.8.0-SNAPSHOT, see <code>@ClassLayout</code>, <code>@PropertyLayout</code>, <code>@CollectionLayout</code>, <code>@ActionLayout</code> and <code>@ParameterLayout</code>
</td>
- <td></td>
<td>Y</td>
</tr>
<tr>
- <td><a href="./SortedBy.html">@SortedBy</a></td>
+ <td><a href="./Exploration-deprecated.html" style="text-decoration: line-through;" >@Exploration</a></td>
<td>UI</td>
- <td>Display instances in collections in the order determined by the provided Comparator.
+ <td>Action available in special 'exploration' mode.
+ <br/>Deprecated in 1.8.0-SNAPSHOT
</td>
<td></td>
- <td></td>
</tr>
<tr>
- <td><a href="./Title.html">@Title</a></td>
+ <td><a href="./FieldOrder-deprecated.html" style="text-decoration: line-through;" >@FieldOrder</a></td>
<td>UI</td>
- <td>Indicates which of the object's properties should be used to build up a title for the object.
+ <td>Order of properties and collections
</td>
<td></td>
+ </tr>
+ <tr>
+ <td><a href="./Hidden-deprecated.html">@Hidden</a></td>
+ <td>UI, Domain</td>
+ <td>Object member is not visible.
+ <br/>Deprecated in 1.8.0-SNAPSHOT
+ </td>
+ <td>Y</td>
+ </tr>
+ <tr>
+ <td><a href="./Idempotent-deprecated.html" style="text-decoration: line-through;" >@Idempotent</a></td>
+ <td>Domain</td>
+ <td>Replaced by @ActionSemantics.
+ </td>
<td></td>
</tr>
<tr>
- <td><a href="./TypeOf.html">@TypeOf</a></td>
+ <td><a href="./Ignore-deprecated.html" style="text-decoration: line-through;" >@Ignore</a></td>
<td>Domain</td>
- <td>The type of entity stored within a collection (if cannot be otherwise inferred, eg from generics).
+ <td>Replaced by @Programmatic.
</td>
<td></td>
+ </tr>
+ <tr>
+ <td><a href="./Mask-deprecated.html">@Mask</a></td>
+ <td>UI/domain</td>
+ <td>How to parse/render values (never properly supported)
+ </td>
<td></td>
</tr>
<tr>
- <td><a href="./TypicalLength.html">@TypicalLength</a></td>
+ <td><a href="./MemberGroups-deprecated.html">@MemberGroups</a></td>
<td>UI</td>
- <td>The typical length of a string property, eg to determine a sensible length for a textbox.
- </td>
+ <td>Replaced by @MemberGroupLayout</td>
+ <td>Y</td>
+ </tr>
+ <tr>
+ <td><a href="./MultiLine-deprecated.html">@MultiLine</a></td>
+ <td>UI</td>
+ <td>Render string property over multiple lines (a textarea rather than a textbox).
+ <br/>Deprecated in 1.8.0-SNAPSHOT, see <code>@PropertyLayout</code> and <code>@ParameterLayout</code>
+ </td>
+ <td>Y</td>
+ </tr>
+ <tr>
+ <td><a href="./Named-deprecated.html">@Named</a></td>
+ <td>UI</td>
+ <td>Override name inferred from class. Required for parameter names (prior to Java8).
+ <br/>Deprecated in 1.8.0-SNAPSHOT, see <code>@ClassLayout</code>, <code>@PropertyLayout</code>, <code>@CollectionLayout</code>, <code>@ActionLayout</code> and <code>@ParameterLayout</code>
+ </td>
<td>Y</td>
+ </tr>
+ <tr>
+ <td><a href="./Paged-deprecated.html">@Paged</a></td>
+ <td>UI</td>
+ <td>Number of instances to display in tables representing (parented or standalone) collections.
+ <br/>Deprecated in 1.8.0-SNAPSHOT</td>
<td></td>
</tr>
<tr>
- <td><a href="./Value.html">@Value</a></td>
+ <td><a href="./Plural-deprecated.html">@Plural</a></td>
+ <td>UI</td>
+ <td>For the irregular plural form of an entity type.
+ <br/>Deprecated in 1.8.0-SNAPSHOT, see <code>@ClassLayout</code>
+ </td>
+ <td></td>
+ </tr>
+ <tr>
+ <td><a href="./PostsPropertyChangedEvent-deprecated.html" style="text-decoration: line-through;" >@PostsPropertyChangedEvent</a></td>
<td>Domain</td>
- <td>Specify that a class has value-semantics.
+ <td>Replaced by @PropertyInteraction
</td>
<td></td>
+ <td>Y</td>
+ </tr>
+ <tr>
+ <td><a href="./Prototype-deprecated.html">@Prototype</a></td>
+ <td>UI</td>
+ <td>Indicates that an action should only be visible in 'prototype' mode.
+ <br/>Deprecated in 1.8.0-SNAPSHOT, see <code>@ActionLayout</code>
+ </td>
<td></td>
</tr>
<tr>
- <td><a href="./ViewModel.html">@ViewModel</a></td>
- <td>Domain, Persistence</td>
- <td>Specify that a class is a view model (as opposed to an entity or domain service).
- </td>
+ <td><a href="./QueryOnly-deprecated.html" style="text-decoration: line-through;" >@QueryOnly</a></td>
+ <td>Domain</td>
+ <td>Replaced by @ActionSemantics.</td>
<td></td>
+ </tr>
+ <tr>
+ <td><a href="./Render-deprecated.html">@Render</a></td>
+ <td>UI</td>
+ <td>Eagerly (or lazily) render the contents of a collection.
+ <br/>Deprecated in 1.8.0-SNAPSHOT, see <code>@CollectionLayout</code>
+ </td>
<td></td>
</tr>
+ <tr>
+ <td><a href="./RenderedAsDayBefore-deprecated.html">@RenderedAsDayBefore</a></td>
+ <td>UI</td>
+ <td>Render dates as the day before; ie store [a,b) internally but render [a,b-1]) to end-user.
+ <br/>Deprecated in 1.8.0-SNAPSHOT, see <code>@PropertyLayout</code> and <code>@ParameterLayout</code>
+ </td>
+ <td></td>
+ </tr>
+ <tr>
+ <td><a href="./Resolve-deprecated.html" style="text-decoration: line-through;" >@Resolve</a></td>
+ <td>UI</td>
+ <td>Replaced by <code>@Render</code>.</td>
+ <td></td>
+ </tr>
+ <tr>
+ <td><a href="./SortedBy-deprecated.html">@SortedBy</a></td>
+ <td>UI</td>
+ <td>Display instances in collections in the order determined by the provided Comparator.
+ <br/>Deprecated in 1.8.0-SNAPSHOT, see <code>@CollectionLayout</code>
+ </td>
+ <td></td>
+ </tr>
+ <tr>
+ <td><a href="./TypicalLength-deprecated.html">@TypicalLength</a></td>
+ <td>UI</td>
+ <td>The typical length of a string property, eg to determine a sensible length for a textbox.
+ <br/>Deprecated in 1.8.0-SNAPSHOT, see <code>@PropertyLayout</code> and <code>@ParameterLayout</code>
+ </td>
+ <td>Y</td>
+ </tr>
</table>