http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ParameterLayout.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ParameterLayout.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ParameterLayout.adoc index 838d598..6761765 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ParameterLayout.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ParameterLayout.adoc @@ -19,32 +19,32 @@ The table below summarizes the annotation's attributes. | Description -|xref:rgant.adoc#_rgant-ParameterLayout_cssClass[`cssClass()`] +|xref:../rgant/rgant.adoc#_rgant-ParameterLayout_cssClass[`cssClass()`] |Any string valid as a CSS class -|the css class that a parameter should have, to allow more targetted styling in xref:rgcfg.adoc#_rgcfg_application-specific_application-css[`application.css`] +|the css class that a parameter should have, to allow more targetted styling in xref:../rgcfg/rgcfg.adoc#_rgcfg_application-specific_application-css[`application.css`] -|xref:rgant.adoc#_rgant-ParameterLayout_describedAs[`describedAs()`] +|xref:../rgant/rgant.adoc#_rgant-ParameterLayout_describedAs[`describedAs()`] |String |description of this parameter, eg to be rendered in a tooltip. -|xref:rgant.adoc#_rgant-ParameterLayout_labelPosition[`labelPosition()`] +|xref:../rgant/rgant.adoc#_rgant-ParameterLayout_labelPosition[`labelPosition()`] |`LEFT`, `TOP`, `RIGHT`, `NONE` + (`LEFT`) |in forms, the positioning of the label relative to the property value. + -Default is `LEFT`, unless xref:rgant.adoc#_rgant-ParameterLayout_multiLine[`multiLine`] in which case `TOP`. The value `RIGHT` is only supported for boolean parameters. +Default is `LEFT`, unless xref:../rgant/rgant.adoc#_rgant-ParameterLayout_multiLine[`multiLine`] in which case `TOP`. The value `RIGHT` is only supported for boolean parameters. -|xref:rgant.adoc#_rgant-ParameterLayout_multiLine[`multiLine()`] +|xref:../rgant/rgant.adoc#_rgant-ParameterLayout_multiLine[`multiLine()`] |Positive integer |for string parameters, render as a text area over multiple lines. + -If set > 1, then then xref:rgant.adoc#_rgant-ParameterLayout_labelPosition[`labelPosition`] defaults to `TOP`. +If set > 1, then then xref:../rgant/rgant.adoc#_rgant-ParameterLayout_labelPosition[`labelPosition`] defaults to `TOP`. -|xref:rgant.adoc#_rgant-ParameterLayout_named[`named()`] +|xref:../rgant/rgant.adoc#_rgant-ParameterLayout_named[`named()`] |String |the name of this parameter. + @@ -56,12 +56,12 @@ For Java 7 this is generally required. For Java 8, the name can often be inferre |whether to HTML escape the name of this parameter. -|xref:rgant.adoc#_rgant-ParameterLayout_renderedAsDayBefore[`renderedAsDayBefore()`] +|xref:../rgant/rgant.adoc#_rgant-ParameterLayout_renderedAsDayBefore[`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) -|xref:rgant.adoc#_rgant-ParameterLayout_typicalLength[`typicalLength()`] +|xref:../rgant/rgant.adoc#_rgant-ParameterLayout_typicalLength[`typicalLength()`] | |the typical entry length of a field, use to determine the optimum width for display
http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ParameterLayout_cssClass.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ParameterLayout_cssClass.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ParameterLayout_cssClass.adoc index 277b586..5ba4b7e 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ParameterLayout_cssClass.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ParameterLayout_cssClass.adoc @@ -7,9 +7,9 @@ -The `cssClass()` attribute can be used to render additional CSS classes in the HTML (a wrapping `<div>`) that represents the action parameter. xref:rgcfg.adoc#_rgcfg_application-specific_application-css[Application-specific CSS] can then be used to target and adjust the UI representation of that particular element. +The `cssClass()` attribute can be used to render additional CSS classes in the HTML (a wrapping `<div>`) that represents the action parameter. xref:../rgcfg/rgcfg.adoc#_rgcfg_application-specific_application-css[Application-specific CSS] can then be used to target and adjust the UI representation of that particular element. -This attribute can also be applied to xref:rgant.adoc#_rgant-DomainObjectLayout_cssClass[domain objects], xref:rgant.adoc#_rgant-ViewModelLayout_cssClass[view models], xref:rgant.adoc#_rgant-ActionLayout_cssClass[actions] xref:rgant.adoc#_rgant-PropertyLayout_cssClass[properties], xref:rgant.adoc#_rgant-CollectionLayout_cssClass[collections] and xref:rgant.adoc#_rgant-ParameterLayout_cssClass[parameters]. +This attribute can also be applied to xref:../rgant/rgant.adoc#_rgant-DomainObjectLayout_cssClass[domain objects], xref:../rgant/rgant.adoc#_rgant-ViewModelLayout_cssClass[view models], xref:../rgant/rgant.adoc#_rgant-ActionLayout_cssClass[actions] xref:../rgant/rgant.adoc#_rgant-PropertyLayout_cssClass[properties], xref:../rgant/rgant.adoc#_rgant-CollectionLayout_cssClass[collections] and xref:../rgant/rgant.adoc#_rgant-ParameterLayout_cssClass[parameters]. For example: http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ParameterLayout_describedAs.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ParameterLayout_describedAs.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ParameterLayout_describedAs.adoc index 6c1e285..b4ab0da 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ParameterLayout_describedAs.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ParameterLayout_describedAs.adoc @@ -5,7 +5,7 @@ :_imagesdir: images/ -The `describedAs()` attribute is used to provide a short description of the action parameter to the user. In the xref:ugvw.adoc#[Wicket viewer] it is displayed as a 'tool tip'. The `describedAs()` attribute can also be specified for xref:rgant.adoc#_rgant-CollectionLayout_describedAs[collections], xref:rgant.adoc#_rgant-PropertyLayout_describedAs[properties], xref:rgant.adoc#_rgant-ActionLayout_describedAs[actions], xref:rgant.adoc#_rgant-DomainObjectLayout_describedAs[domain objects] and xref:rgant.adoc#_rgant-ViewModelLayout_describedAs[view models]. +The `describedAs()` attribute is used to provide a short description of the action parameter to the user. In the xref:ugvw.adoc#[Wicket viewer] it is displayed as a 'tool tip'. The `describedAs()` attribute can also be specified for xref:../rgant/rgant.adoc#_rgant-CollectionLayout_describedAs[collections], xref:../rgant/rgant.adoc#_rgant-PropertyLayout_describedAs[properties], xref:../rgant/rgant.adoc#_rgant-ActionLayout_describedAs[actions], xref:../rgant/rgant.adoc#_rgant-DomainObjectLayout_describedAs[domain objects] and xref:../rgant/rgant.adoc#_rgant-ViewModelLayout_describedAs[view models]. Descriptions may be provided for objects, members (properties, collections and actions), and for individual parameters within an action http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ParameterLayout_labelPosition.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ParameterLayout_labelPosition.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ParameterLayout_labelPosition.adoc index 5a7a017..0242245 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ParameterLayout_labelPosition.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ParameterLayout_labelPosition.adoc @@ -6,9 +6,9 @@ -The `labelPosition()` attribute determines the positioning of labels for parameters. This attribute can also be specified for xref:rgant.adoc#_rgant-PropertyLayout_labelPosition[properties]. +The `labelPosition()` attribute determines the positioning of labels for parameters. This attribute can also be specified for xref:../rgant/rgant.adoc#_rgant-PropertyLayout_labelPosition[properties]. -The positioning of labels is typically `LEFT`, but can be positioned to the `TOP`. The one exception is xref:rgant.adoc#_rgant-ParameterLayout_multiLine[`multiLine()`] string parameters, where the label defaults to `TOP` automatically (to provide as much real-estate for the multiline text field as possible). +The positioning of labels is typically `LEFT`, but can be positioned to the `TOP`. The one exception is xref:../rgant/rgant.adoc#_rgant-ParameterLayout_multiLine[`multiLine()`] string parameters, where the label defaults to `TOP` automatically (to provide as much real-estate for the multiline text field as possible). For boolean parameters a positioning of `RIGHT` is also allowed; this is ignored for all other types. @@ -36,6 +36,6 @@ public class Order { ---- -To get an idea of how these are rendered (in the xref:ugvw.adoc#[Wicket viewer]), see xref:rgant.adoc#_rgant-PropertyLayout_labelPosition[PropertyLayout#labelPosition()]. +To get an idea of how these are rendered (in the xref:ugvw.adoc#[Wicket viewer]), see xref:../rgant/rgant.adoc#_rgant-PropertyLayout_labelPosition[PropertyLayout#labelPosition()]. http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ParameterLayout_multiLine.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ParameterLayout_multiLine.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ParameterLayout_multiLine.adoc index 5746439..18ff449 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ParameterLayout_multiLine.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ParameterLayout_multiLine.adoc @@ -6,7 +6,7 @@ -The `multiLine()` attribute specifies that the text field for a string parameter should span multiple lines. It is ignored for other parameter types. The attribute is also supported for xref:rgant.adoc#_rgant-PropertyLayout_multiLine[properties]. +The `multiLine()` attribute specifies that the text field for a string parameter should span multiple lines. It is ignored for other parameter types. The attribute is also supported for xref:../rgant/rgant.adoc#_rgant-PropertyLayout_multiLine[properties]. For example: @@ -27,6 +27,6 @@ public class BugReport { [NOTE] ==== -If set > 1 (as would normally be the case), then the default xref:rgant.adoc#_rgant-ParameterLayout_labelPosition[`labelPosition`] defaults to `TOP` (rather than `LEFT`, as would normally be the case). +If set > 1 (as would normally be the case), then the default xref:../rgant/rgant.adoc#_rgant-ParameterLayout_labelPosition[`labelPosition`] defaults to `TOP` (rather than `LEFT`, as would normally be the case). ==== http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ParameterLayout_named.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ParameterLayout_named.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ParameterLayout_named.adoc index 3b589d0..b34662f 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ParameterLayout_named.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ParameterLayout_named.adoc @@ -6,11 +6,11 @@ -The `named()` attribute explicitly specifies the action parameter's name. This attribute can also be specified for xref:rgant.adoc#_rgant-ActionLayout_named[actions], xref:rgant.adoc#_rgant-CollectionLayout_named[collections], xref:rgant.adoc#_rgant-PropertyLayout_named[properties], xref:rgant.adoc#_rgant-DomainObjectLayout_named[domain objects], xref:rgant.adoc#_rgant-ViewModelLayout_named[view models] and xref:rgant.adoc#_rgant-DomainServiceLayout_named[domain services]. +The `named()` attribute explicitly specifies the action parameter's name. This attribute can also be specified for xref:../rgant/rgant.adoc#_rgant-ActionLayout_named[actions], xref:../rgant/rgant.adoc#_rgant-CollectionLayout_named[collections], xref:../rgant/rgant.adoc#_rgant-PropertyLayout_named[properties], xref:../rgant/rgant.adoc#_rgant-DomainObjectLayout_named[domain objects], xref:../rgant/rgant.adoc#_rgant-ViewModelLayout_named[view models] and xref:../rgant/rgant.adoc#_rgant-DomainServiceLayout_named[domain services]. Unlike most other aspects of the Apache Isis metamodel, the name of method parameters cannot (prior to Java 8, at least) be inferred from the Java source code. Without other information, Apache Isis uses the object's type (`int`, `String` etc) as the name instead. This can be sufficient for application-specific reference types (eg `ToDoItem`) but is generally not sufficient for primitives and other value types. -The `named()` attribute (or the xref:rgant.adoc#_rgant-aaa_deprecated[deprecated `@Named`] annotation) is therefore often required to specify the parameter name. +The `named()` attribute (or the xref:../rgant/rgant.adoc#_rgant-aaa_deprecated[deprecated `@Named`] annotation) is therefore often required to specify the parameter name. As of Java 8, the Java reflection API has been extended. The (non-ASF) http://github.com/isisaddons/isis-metamodel-paraname8[Isis addons' paraname8] metamodel extension provides support for this. Note that your application must (obviously) be running on Java 8, and be compiled with the `-parameters` compile flag for javac. http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ParameterLayout_renderedAsDayBefore.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ParameterLayout_renderedAsDayBefore.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ParameterLayout_renderedAsDayBefore.adoc index ccf9540..8bf1fd5 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ParameterLayout_renderedAsDayBefore.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ParameterLayout_renderedAsDayBefore.adoc @@ -6,7 +6,7 @@ -The `renderedAsDayBefore()` attribute applies only to date parameters whereby the date will be rendered as the day before the value actually held in the domain object. It is ignored for parameters of other types. This attribute is also supported for xref:rgant.adoc#_rgant-PropertyLayout_renderedAsDayBefore[properties]. +The `renderedAsDayBefore()` attribute applies only to date parameters whereby the date will be rendered as the day before the value actually held in the domain object. It is ignored for parameters of other types. This attribute is also supported for xref:../rgant/rgant.adoc#_rgant-PropertyLayout_renderedAsDayBefore[properties]. This behaviour might at first glance appear odd, but the rationale is to support the use case of a sequence of instances that represent adjacent intervals of time. In such cases there would typically be `startDate` and `endDate` properties, eg for all of Q2. Storing this as a half-closed interval -- eg `[1-Apr-2015, 1-July-2015)` -- can substantially simplify internal algorithms; the `endDate` of one interval will correspond to the `startDate` of the next. http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ParameterLayout_typicalLength.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ParameterLayout_typicalLength.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ParameterLayout_typicalLength.adoc index 120da18..bcc9c7c 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ParameterLayout_typicalLength.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ParameterLayout_typicalLength.adoc @@ -6,7 +6,7 @@ -The `typicalLength()` attribute indicates the typical length of a string parameter. It is ignored for parameters of other types. The attribute is also supported for xref:rgant.adoc#_rgant-PropertyLayout_typicalLength[properties]. +The `typicalLength()` attribute indicates the typical length of a string parameter. It is ignored for parameters of other types. The attribute is also supported for xref:../rgant/rgant.adoc#_rgant-PropertyLayout_typicalLength[properties]. The information is intended as a hint to the UI to determine the space that should be given to render a particular string parameter. That said, note that the xref:ugvw.adoc#[Wicket viewer] uses the maximum space available for all fields, so in effect ignores this attribute. http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Parameter_fileAccept.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Parameter_fileAccept.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Parameter_fileAccept.adoc index f16f13d..e309616 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Parameter_fileAccept.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Parameter_fileAccept.adoc @@ -6,9 +6,9 @@ -The `fileAccept()` attribute applies only to xref:rgcms.adoc#_rgcms_classes_value-types_Blob[`Blob`] -or xref:rgcms.adoc#_rgcms_classes_value-types_Clob[`Clob`] parameters, indicating the type of file to accept when -uploading a new value. The attribute is also supported on xref:rgant.adoc#_rgant-Property_fileAccept[properties]. +The `fileAccept()` attribute applies only to xref:../rgcms/rgcms.adoc#_rgcms_classes_value-types_Blob[`Blob`] +or xref:../rgcms/rgcms.adoc#_rgcms_classes_value-types_Clob[`Clob`] parameters, indicating the type of file to accept when +uploading a new value. The attribute is also supported on xref:../rgant/rgant.adoc#_rgant-Property_fileAccept[properties]. For example: http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Parameter_maxLength.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Parameter_maxLength.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Parameter_maxLength.adoc index 10d6548..5baa3e4 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Parameter_maxLength.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Parameter_maxLength.adoc @@ -6,7 +6,7 @@ -The `maxLength()` attribute applies only to `String` parameters, indicating the maximum number of characters that the user may enter (for example in a text field in the UI). It is ignored if applied to parameters of any other type. This attribute can also be applied to xref:rgant.adoc#_rgant-Property_maxLength[properties]. +The `maxLength()` attribute applies only to `String` parameters, indicating the maximum number of characters that the user may enter (for example in a text field in the UI). It is ignored if applied to parameters of any other type. This attribute can also be applied to xref:../rgant/rgant.adoc#_rgant-Property_maxLength[properties]. For example: http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Parameter_mustSatisfy.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Parameter_mustSatisfy.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Parameter_mustSatisfy.adoc index de288f0..0a7643e 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Parameter_mustSatisfy.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Parameter_mustSatisfy.adoc @@ -6,11 +6,11 @@ -The `mustSatisfy()` attribute allows arbitrary validation to be applied to parameters using an (implementation of a) `org.apache.isis.applib.spec.Specification` object. The attribute is also supported on xref:rgant.adoc#_rgant-Property_mustSatisfy[properties]. +The `mustSatisfy()` attribute allows arbitrary validation to be applied to parameters using an (implementation of a) `org.apache.isis.applib.spec.Specification` object. The attribute is also supported on xref:../rgant/rgant.adoc#_rgant-Property_mustSatisfy[properties]. [TIP] ==== -The specification implementations can (of course) be reused between parameters and xref:rgant.adoc#_rgant-Property_mustSatisfy[properties]. +The specification implementations can (of course) be reused between parameters and xref:../rgant/rgant.adoc#_rgant-Property_mustSatisfy[properties]. ==== The `Specification` is consulted during validation, being passed the proposed value. If the proposed value fails, then the value returned is the used as the invalidity reason. http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Parameter_optionality.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Parameter_optionality.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Parameter_optionality.adoc index 7715a9e..9d59d04 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Parameter_optionality.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Parameter_optionality.adoc @@ -7,7 +7,7 @@ -By default, Apache Isis assumes that all parameters of an action are required (mandatory). The `optionality()` attribute allows this to be relaxed. The attribute is also supported for xref:rgant.adoc#_rgant-Property_optionality[properties]. +By default, Apache Isis assumes that all parameters of an action are required (mandatory). The `optionality()` attribute allows this to be relaxed. The attribute is also supported for xref:../rgant/rgant.adoc#_rgant-Property_optionality[properties]. [TIP] @@ -38,5 +38,5 @@ public class Customer { [NOTE] ==== -It is also possible to specify optionality using xref:rgant.adoc#_rgant_Nullable[`@Nullable`] annotation. +It is also possible to specify optionality using xref:../rgant/rgant.adoc#_rgant_Nullable[`@Nullable`] annotation. ==== http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Parameter_regexPattern.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Parameter_regexPattern.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Parameter_regexPattern.adoc index bc29ef3..103ad2e 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Parameter_regexPattern.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Parameter_regexPattern.adoc @@ -8,7 +8,7 @@ There are three attributes related to enforcing regular expressions: -* The `regexPattern()` attribute validates the contents of any string parameter with respect to a regular expression pattern. It is ignored if applied to parameters of any other type. This attribute can also be specified for xref:rgant.adoc#_rgant-Property_regexPattern[properties]. +* The `regexPattern()` attribute validates the contents of any string parameter with respect to a regular expression pattern. It is ignored if applied to parameters of any other type. This attribute can also be specified for xref:../rgant/rgant.adoc#_rgant-Property_regexPattern[properties]. * The `regexPatternFlags()` attribute specifies flags that modify the handling of the pattern. The values are those that would normally be passed to `java.util.regex.Pattern#compile(String,int)`. http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PersistenceCapable.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PersistenceCapable.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PersistenceCapable.adoc index 88d71c8..5e42bfa 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PersistenceCapable.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PersistenceCapable.adoc @@ -22,12 +22,12 @@ This value is used internally to generate a string representation of an objects This can appear in several contexts, including: * as the value of `Bookmark#getObjectType()` and in the `toString()` value of `Bookmark` - (see xref:rgsvc.adoc#_rgsvc_api_BookmarkService[`BookmarkService`]) + (see xref:../rgsvc/rgsvc.adoc#_rgsvc_api_BookmarkService[`BookmarkService`]) ** and thus in the "table-of-two-halves" pattern, as per (non-ASF) http://github.com/isisaddons/isis-module-poly[Isis addons' poly] module -* in the serialization of `OidDto` in the xref:rgcms.adoc#_rgcms_schema-cmd[command] and xref:rgcms.adoc#_rgcms_schema-ixn[interaction] schemas +* in the serialization of `OidDto` in the xref:../rgcms/rgcms.adoc#_rgcms_schema-cmd[command] and xref:../rgcms/rgcms.adoc#_rgcms_schema-ixn[interaction] schemas * in the URLs of the xref:ugvro.adoc#[RestfulObjects viewer] * in the URLs of the xref:ugvw.adoc#[Wicket viewer] (in general and in particular if xref:ugvw.adoc#_ugvw_features_hints-and-copy-url[copying URLs]) -* in XML snapshots generated by the xref:rgsvc.adoc#_rgsvc_api_XmlSnapshotService[`XmlSnapshotService`] +* in XML snapshots generated by the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_XmlSnapshotService[`XmlSnapshotService`] The actual format of the object type used by Apache Isis for the concatenation of `schema()` and `@PersistenceCapable#table()`. @@ -77,9 +77,9 @@ does _not_ correspond to an object type, because the `schema()` attribute is mis The rules of precedence for determining a domain object's object type are: -1. xref:rgant.adoc#_rgant_Discriminator[`@Discriminator`] +1. xref:../rgant/rgant.adoc#_rgant_Discriminator[`@Discriminator`] 2. `@DomainObject#objectType` -3. xref:rgant.adoc#_rgant_PersistenceCapable[`@PersistenceCapable`], if at least the `schema` attribute is defined. + +3. xref:../rgant/rgant.adoc#_rgant_PersistenceCapable[`@PersistenceCapable`], if at least the `schema` attribute is defined. + + If both `schema` and `table` are defined, then the value is "`schema.table`". If only `schema` is defined, then the value is "`schema.className`". http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PostConstruct.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PostConstruct.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PostConstruct.adoc index 1b1fff6..4af546d 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PostConstruct.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PostConstruct.adoc @@ -7,9 +7,9 @@ The `@javax.annotation.PostConstruct` annotation, as defined in link:https://jcp.org/en/jsr/detail?id=250[JSR-250], is recognized by Apache Isis as a callback method on domain services to be called just after they have been constructed, in order that they initialize themselves. -It is also recognized for xref:ugbtb.adoc#_ugbtb_view-models[view models] (eg annotated with xref:rgant.adoc#_rgant-ViewModel[`@ViewModel`]). +It is also recognized for xref:ugbtb.adoc#_ugbtb_view-models[view models] (eg annotated with xref:../rgant/rgant.adoc#_rgant-ViewModel[`@ViewModel`]). -For the default application-scoped (singleton) domain services, this means that the method, if present, is called during the bootstrapping of the application. For xref:rgant.adoc#_rgant-RequestScoped[`@RequestScoped`] domain services, the method is called at the beginning of the request. +For the default application-scoped (singleton) domain services, this means that the method, if present, is called during the bootstrapping of the application. For xref:../rgant/rgant.adoc#_rgant-RequestScoped[`@RequestScoped`] domain services, the method is called at the beginning of the request. The signature of the method is: @@ -18,7 +18,7 @@ The signature of the method is: @PostConstruct <1> public void init() { ... } <2> ---- -<1> It is not necessary to annotate the method with xref:rgant.adoc#_rgant-Programmatic[`@Programmatic`]; it will be automatically excluded from the Apache Isis metamodel. +<1> It is not necessary to annotate the method with xref:../rgant/rgant.adoc#_rgant-Programmatic[`@Programmatic`]; it will be automatically excluded from the Apache Isis metamodel. <2> the method can have any name, but must have `public` visibility. In the form shown above the method accepts no arguments. Alternatively - for domain services only, not view models - the method can accept a parameter of type `Map<String,String>`: @@ -29,14 +29,14 @@ In the form shown above the method accepts no arguments. Alternatively - for do @Programmatic public void init(Map<String,String> properties) { ... } ---- -Isis uses argument to pass in the configuration properties read from all xref:rgcfg.adoc#_rgcfg_configuration-files[configuration files]: +Isis uses argument to pass in the configuration properties read from all xref:../rgcfg/rgcfg.adoc#_rgcfg_configuration-files[configuration files]: [TIP] ==== -Alternatively, you could inject xref:rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainObjectContainer`] into the service and read configuration properties using `DomainObjectContainer#getProperty(...)` and related methods. Note that when using this latter API only those configuration properties prefixes `application.` key are provided. +Alternatively, you could inject xref:../rgsvc/rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainObjectContainer`] into the service and read configuration properties using `DomainObjectContainer#getProperty(...)` and related methods. Note that when using this latter API only those configuration properties prefixes `application.` key are provided. ==== -A common use case is for domain services that interact with the xref:rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`]. For example: +A common use case is for domain services that interact with the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`]. For example: [source,java] ---- @@ -58,7 +58,7 @@ public class MySubscribingService { [TIP] ==== -In this particular use case, it is generally simpler to just subclass from xref:rgcms.adoc#_rgcms_classes_super_AbstractSubscriber[`AbstractSubscriber`]. +In this particular use case, it is generally simpler to just subclass from xref:../rgcms/rgcms.adoc#_rgcms_classes_super_AbstractSubscriber[`AbstractSubscriber`]. ==== @@ -68,4 +68,4 @@ Other use cases include obtaining connections to external datasources, eg subscr -See also xref:rgant.adoc#_rgant-PreDestroy[`@PreDestroy`] \ No newline at end of file +See also xref:../rgant/rgant.adoc#_rgant-PreDestroy[`@PreDestroy`] \ No newline at end of file http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PreDestroy.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PreDestroy.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PreDestroy.adoc index bf8a63b..13c6c0b 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PreDestroy.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PreDestroy.adoc @@ -9,7 +9,7 @@ The `@javax.annotation.PreDestroy` annotation, as defined in link:https://jcp.org/en/jsr/detail?id=250[JSR-250], recognized by Apache Isis as a callback method on domain services to be called just as they go out of scope. -For the default application-scoped (singleton) domain services, this means that the method, if present, is called just prior to the termination of the application. For xref:rgant.adoc#_rgant-RequestScoped[`@RequestScoped`] domain services, the method is called at the end of the request. +For the default application-scoped (singleton) domain services, this means that the method, if present, is called just prior to the termination of the application. For xref:../rgant/rgant.adoc#_rgant-RequestScoped[`@RequestScoped`] domain services, the method is called at the end of the request. The signature of the method is: @@ -18,10 +18,10 @@ The signature of the method is: @PreDestroy <1> public void deinit() { ... } <2> ---- -<1> It is not necessary to annotate the method with xref:rgant.adoc#_rgant-Programmatic[`@Programmatic`]; it will be automatically excluded from the Apache Isis metamodel. +<1> It is not necessary to annotate the method with xref:../rgant/rgant.adoc#_rgant-Programmatic[`@Programmatic`]; it will be automatically excluded from the Apache Isis metamodel. <2> the method can have any name, but must have `public` visibility, and accept no arguments. -A common use case is for domain services that interact with the xref:rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`]. For example: +A common use case is for domain services that interact with the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`]. For example: [source,java] ---- @@ -43,11 +43,11 @@ public class MySubscribingService { [TIP] ==== -In this particular use case, it is generally simpler to just subclass from xref:rgcms.adoc#_rgcms_classes_super_AbstractSubscriber[`AbstractSubscriber`]. +In this particular use case, it is generally simpler to just subclass from xref:../rgcms/rgcms.adoc#_rgcms_classes_super_AbstractSubscriber[`AbstractSubscriber`]. ==== Other use cases include obtaining connections to external datasources, eg subscribing to an ActiveMQ router, say, or initializing/cleaning up a background scheduler such as Quartz. -See also xref:rgant.adoc#_rgant-PostConstruct[`@PostConstruct`] \ No newline at end of file +See also xref:../rgant/rgant.adoc#_rgant-PostConstruct[`@PostConstruct`] \ No newline at end of file http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PrimaryKey.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PrimaryKey.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PrimaryKey.adoc index b4b4164..4bbfbb9 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PrimaryKey.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PrimaryKey.adoc @@ -8,7 +8,7 @@ The `@javax.jdo.annotation.PrimaryKey` annotation is used by JDO/DataNucleus to indicate that a property is used as the primary key for an entity with application-managed identity. -Apache Isis also uses this annotation in a very minimal way: to ensure that the framework's own logic to initialize newly instantiated objects (eg using xref:rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainObjectContainer#newTransientInstance(...)`] does not touch the primary key, and also to ensure that the primary key property is always disabled (read-only). +Apache Isis also uses this annotation in a very minimal way: to ensure that the framework's own logic to initialize newly instantiated objects (eg using xref:../rgsvc/rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainObjectContainer#newTransientInstance(...)`] does not touch the primary key, and also to ensure that the primary key property is always disabled (read-only). [NOTE] ==== http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Programmatic.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Programmatic.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Programmatic.adoc index 9a9a32e..cec0b6e 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Programmatic.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Programmatic.adoc @@ -5,7 +5,7 @@ :_imagesdir: images/ -The `@Programmatic` annotation causes the method to be excluded completely from the Apache Isis metamodel. This means it won't appear in any UI, and it won't appear in any xref:rgsvc.adoc#_rgsvc_api_MementoService[memento]s or xref:rgsvc.adoc#_rgsvc_api_XmlSnapshotService[snapshot]s. +The `@Programmatic` annotation causes the method to be excluded completely from the Apache Isis metamodel. This means it won't appear in any UI, and it won't appear in any xref:../rgsvc/rgsvc.adoc#_rgsvc_api_MementoService[memento]s or xref:../rgsvc/rgsvc.adoc#_rgsvc_api_XmlSnapshotService[snapshot]s. A common use-case is to ignore implementation-level artifacts. For example: http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property.adoc index 0c867ef..3bcb1a1 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property.adoc @@ -20,45 +20,45 @@ It is also possible to apply the annotation to actions of domain services that a | Description -|xref:rgant.adoc#_rgant-Property_domainEvent[`domainEvent()`] +|xref:../rgant/rgant.adoc#_rgant-Property_domainEvent[`domainEvent()`] |subtype of `PropertyDomainEvent` + (`PropertyDomainEvent.Default`) -|the event type to be posted to the xref:rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] to broadcast the property's business rule checking (hide, disable, validate) and its modification (before and after). +|the event type to be posted to the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] to broadcast the property's business rule checking (hide, disable, validate) and its modification (before and after). -|xref:rgant.adoc#_rgant-Property_editing[`editing()`] +|xref:../rgant/rgant.adoc#_rgant-Property_editing[`editing()`] |`ENABLED`, `DISABLED`, `AS_CONFIGURED` + (`AS_CONFIGURED`) |whether a property can be modified or cleared from within the UI -|xref:rgant.adoc#_rgant-Property_fileAccept[`fileAccept()`] +|xref:../rgant/rgant.adoc#_rgant-Property_fileAccept[`fileAccept()`] |Media type or file extension -|Hints the files to be uploaded to a xref:rgcms.adoc#_rgcms_classes_value-types_Blob[`Blob`] - or xref:rgcms.adoc#_rgcms_classes_value-types_Clob[`Clob`]. + +|Hints the files to be uploaded to a xref:../rgcms/rgcms.adoc#_rgcms_classes_value-types_Blob[`Blob`] + or xref:../rgcms/rgcms.adoc#_rgcms_classes_value-types_Clob[`Clob`]. + + Note that this does not prevent the user from uploading some other file type; rather it merely defaults the file type in the file open dialog. -|xref:rgant.adoc#_rgant-Property_hidden[`hidden()`] +|xref:../rgant/rgant.adoc#_rgant-Property_hidden[`hidden()`] |`EVERYWHERE`, `OBJECT_FORMS`, `PARENTED_TABLES`, `STANDALONE_TABLES`, `ALL_TABLES`, `NOWHERE` + (`NOWHERE`) |indicates where (in the UI) the property should be hidden from the user. -|xref:rgant.adoc#_rgant-Property_maxLength[`maxLength()`] +|xref:../rgant/rgant.adoc#_rgant-Property_maxLength[`maxLength()`] | |maximum number of characters for string parameters; ignored otherwise + -In many/most cases you should however use xref:rgant.adoc#_rgant-Column[`@Column#length()`] +In many/most cases you should however use xref:../rgant/rgant.adoc#_rgant-Column[`@Column#length()`] -|xref:rgant.adoc#_rgant-Property_mustSatisfy[`mustSatisfy()`] +|xref:../rgant/rgant.adoc#_rgant-Property_mustSatisfy[`mustSatisfy()`] |implementation of `o.a.i.applib.spec.Specification` |allows arbitrary validation to be applied -|xref:rgant.adoc#_rgant-Property_notPersisted[`notPersisted()`] +|xref:../rgant/rgant.adoc#_rgant-Property_notPersisted[`notPersisted()`] |`true`, `false` + (`false`) |whether to exclude from snapshots. + @@ -69,15 +69,15 @@ Property must also be annotated with `@javax.jdo.annotations.NotPersistent` in o ==== -|xref:rgant.adoc#_rgant-Property_optionality[`optionality()`] +|xref:../rgant/rgant.adoc#_rgant-Property_optionality[`optionality()`] | |specifies a property is optional rather than mandatory + -In many/most cases you should however use xref:rgant.adoc#_rgant-Column[`@Column#allowsNull()`] +In many/most cases you should however use xref:../rgant/rgant.adoc#_rgant-Column[`@Column#allowsNull()`] -|xref:rgant.adoc#_rgant-Property_regexPattern[`regexPattern()`] +|xref:../rgant/rgant.adoc#_rgant-Property_regexPattern[`regexPattern()`] |regular expression |validates the contents of a string parameter against the regular expression pattern @@ -124,7 +124,7 @@ public class Customer { [TIP] ==== -The annotation is one of a handful (others including xref:rgant.adoc#_rgant-Collection[`@Collection`], xref:rgant.adoc#_rgant-CollectionLayout[`@CollectionLayout`] and xref:rgant.adoc#_rgant-PropertyLayout[`@PropertyLayout`]) that can also be applied to the field, rather than the getter method. This is specifically +The annotation is one of a handful (others including xref:../rgant/rgant.adoc#_rgant-Collection[`@Collection`], xref:../rgant/rgant.adoc#_rgant-CollectionLayout[`@CollectionLayout`] and xref:../rgant/rgant.adoc#_rgant-PropertyLayout[`@PropertyLayout`]) that can also be applied to the field, rather than the getter method. This is specifically so that boilerplate-busting tools such as link:https://projectlombok.org/[Project Lombok] can be used. ==== http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PropertyLayout.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PropertyLayout.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PropertyLayout.adoc index 1023ea9..96517ee 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PropertyLayout.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PropertyLayout.adoc @@ -19,40 +19,40 @@ The table below summarizes the annotation's attributes. | Description -|xref:rgant.adoc#_rgant-PropertyLayout_cssClass[`cssClass()`] +|xref:../rgant/rgant.adoc#_rgant-PropertyLayout_cssClass[`cssClass()`] |Any string valid as a CSS class -|the css class that a property should have, to allow more targetted styling in xref:rgcfg.adoc#_rgcfg_application-specific_application-css[`application.css`] +|the css class that a property should have, to allow more targetted styling in xref:../rgcfg/rgcfg.adoc#_rgcfg_application-specific_application-css[`application.css`] -|xref:rgant.adoc#_rgant-PropertyLayout_describedAs[`describedAs()`] +|xref:../rgant/rgant.adoc#_rgant-PropertyLayout_describedAs[`describedAs()`] |String |description of this property, eg to be rendered in a tooltip. -|xref:rgant.adoc#_rgant-PropertyLayout_hidden[`hidden()`] +|xref:../rgant/rgant.adoc#_rgant-PropertyLayout_hidden[`hidden()`] |`EVERYWHERE`, `OBJECT_FORMS`, `PARENTED_TABLES`, `STANDALONE_TABLES`, `ALL_TABLES`, `NOWHERE` + (`NOWHERE`) |indicates where (in the UI) the property should be hidden from the user. -|xref:rgant.adoc#_rgant-PropertyLayout_labelPosition[`labelPosition()`] +|xref:../rgant/rgant.adoc#_rgant-PropertyLayout_labelPosition[`labelPosition()`] |`LEFT`, `TOP`, `RIGHT`, `NONE` + (`LEFT`) |in forms, the positioning of the label relative to the property value. + -Defaults is `LEFT`, unless xref:rgant.adoc#_rgant-PropertyLayout_multiLine[`multiLine`] in which case `TOP`. The value `RIGHT` is only supported for boolean properties. + +Defaults is `LEFT`, unless xref:../rgant/rgant.adoc#_rgant-PropertyLayout_multiLine[`multiLine`] in which case `TOP`. The value `RIGHT` is only supported for boolean properties. + -It is also possible to change the default through a xref:rgcfg.adoc#__rgcfg_configuring-core_isis-viewers-propertyLayout-labelPosition[configuration property] +It is also possible to change the default through a xref:../rgcfg/rgcfg.adoc#__rgcfg_configuring-core_isis-viewers-propertyLayout-labelPosition[configuration property] -|xref:rgant.adoc#_rgant-PropertyLayout_multiLine[`multiLine()`] +|xref:../rgant/rgant.adoc#_rgant-PropertyLayout_multiLine[`multiLine()`] |Positive integer |for string properties, render as a text area over multiple lines. + -If set > 1, then xref:rgant.adoc#_rgant-PropertyLayout_labelPosition[`labelPosition`] defaults to TOP. +If set > 1, then xref:../rgant/rgant.adoc#_rgant-PropertyLayout_labelPosition[`labelPosition`] defaults to TOP. -|xref:rgant.adoc#_rgant-PropertyLayout_named[`named()`] +|xref:../rgant/rgant.adoc#_rgant-PropertyLayout_named[`named()`] |String |to override the name inferred from the collection's name in code. + @@ -65,13 +65,13 @@ A typical use case is if the desired name is a reserved Java keyword, such as `d |whether to HTML escape the name of this property. -|xref:rgant.adoc#_rgant-PropertyLayout_renderedAsDayBefore[`renderedAsDayBefore()`] +|xref:../rgant/rgant.adoc#_rgant-PropertyLayout_renderedAsDayBefore[`renderedAsDayBefore()`] |`true`, `false` + (`false`) |for date properties only, render the date as one day prior to the actually stored date. -|xref:rgant.adoc#_rgant-PropertyLayout_typicalLength[`typicalLength()`] +|xref:../rgant/rgant.adoc#_rgant-PropertyLayout_typicalLength[`typicalLength()`] |Positive integer. |the typical entry length of a field, use to determine the optimum width for display @@ -113,7 +113,7 @@ As an alternative to using the `@PropertyLayout` annotation, a xref:ugvw.adoc#_u [TIP] ==== -The annotation is one of a handful (others including xref:rgant.adoc#_rgant-Collection[`@Collection`], xref:rgant.adoc#_rgant-CollectionLayout[`@CollectionLayout`] and xref:rgant.adoc#_rgant-Property[`@Property`]) that can also be applied to the field, rather than the getter method. This is specifically +The annotation is one of a handful (others including xref:../rgant/rgant.adoc#_rgant-Collection[`@Collection`], xref:../rgant/rgant.adoc#_rgant-CollectionLayout[`@CollectionLayout`] and xref:../rgant/rgant.adoc#_rgant-Property[`@Property`]) that can also be applied to the field, rather than the getter method. This is specifically so that boilerplate-busting tools such as link:https://projectlombok.org/[Project Lombok] can be used. ==== http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PropertyLayout_cssClass.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PropertyLayout_cssClass.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PropertyLayout_cssClass.adoc index 4e51fef..c5580e8 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PropertyLayout_cssClass.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PropertyLayout_cssClass.adoc @@ -5,9 +5,9 @@ :_imagesdir: images/ -The `cssClass()` attribute can be used to render additional CSS classes in the HTML (a wrapping `<div>`) that represents the property. xref:rgcfg.adoc#_rgcfg_application-specific_application-css[Application-specific CSS] can then be used to target and adjust the UI representation of that particular element. +The `cssClass()` attribute can be used to render additional CSS classes in the HTML (a wrapping `<div>`) that represents the property. xref:../rgcfg/rgcfg.adoc#_rgcfg_application-specific_application-css[Application-specific CSS] can then be used to target and adjust the UI representation of that particular element. -This attribute can also be applied to xref:rgant.adoc#_rgant-DomainObjectLayout_cssClass[domain objects], xref:rgant.adoc#_rgant-ViewModelLayout_cssClass[view models], xref:rgant.adoc#_rgant-ActionLayout_cssClass[actions] xref:rgant.adoc#_rgant-CollectionLayout_cssClass[collections] and xref:rgant.adoc#_rgant-ParameterLayout_cssClass[parameters]. +This attribute can also be applied to xref:../rgant/rgant.adoc#_rgant-DomainObjectLayout_cssClass[domain objects], xref:../rgant/rgant.adoc#_rgant-ViewModelLayout_cssClass[view models], xref:../rgant/rgant.adoc#_rgant-ActionLayout_cssClass[actions] xref:../rgant/rgant.adoc#_rgant-CollectionLayout_cssClass[collections] and xref:../rgant/rgant.adoc#_rgant-ParameterLayout_cssClass[parameters]. For example: http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PropertyLayout_describedAs.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PropertyLayout_describedAs.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PropertyLayout_describedAs.adoc index d67555b..5644f47 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PropertyLayout_describedAs.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PropertyLayout_describedAs.adoc @@ -6,7 +6,7 @@ -The `describedAs()` attribute is used to provide a short description of the property to the user. In the xref:ugvw.adoc#[Wicket viewer] it is displayed as a 'tool tip'. The attribute can also be specified for xref:rgant.adoc#_rgant-CollectionLayout_describedAs[collections], xref:rgant.adoc#_rgant-ActionLayout_describedAs[actions], xref:rgant.adoc#_rgant-ParameterLayout_describedAs[parameters], xref:rgant.adoc#_rgant-DomainObjectLayout_describedAs[domain objects] and xref:rgant.adoc#_rgant-ViewModelLayout_describedAs[view models]. +The `describedAs()` attribute is used to provide a short description of the property to the user. In the xref:ugvw.adoc#[Wicket viewer] it is displayed as a 'tool tip'. The attribute can also be specified for xref:../rgant/rgant.adoc#_rgant-CollectionLayout_describedAs[collections], xref:../rgant/rgant.adoc#_rgant-ActionLayout_describedAs[actions], xref:../rgant/rgant.adoc#_rgant-ParameterLayout_describedAs[parameters], xref:../rgant/rgant.adoc#_rgant-DomainObjectLayout_describedAs[domain objects] and xref:../rgant/rgant.adoc#_rgant-ViewModelLayout_describedAs[view models]. For example: http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PropertyLayout_hidden.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PropertyLayout_hidden.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PropertyLayout_hidden.adoc index 5c794d2..3391532 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PropertyLayout_hidden.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PropertyLayout_hidden.adoc @@ -6,11 +6,11 @@ -The `hidden()` attribute indicates where (in the UI) the property should be hidden from the user. This attribute can also be applied to xref:rgant.adoc#_rgant-Action_hidden[actions] and xref:rgant.adoc#_rgant-Collection_hidden[collections]. +The `hidden()` attribute indicates where (in the UI) the property should be hidden from the user. This attribute can also be applied to xref:../rgant/rgant.adoc#_rgant-Action_hidden[actions] and xref:../rgant/rgant.adoc#_rgant-Collection_hidden[collections]. [TIP] ==== -It is also possible to use xref:rgant.adoc#_rgant-PropertyLayout_hidden[`@PropertyLayout#hidden()`] or a xref:ugvw.adoc#_ugvw_layout_file-based[file-based layout] such that the property can be hidden at the view layer. +It is also possible to use xref:../rgant/rgant.adoc#_rgant-PropertyLayout_hidden[`@PropertyLayout#hidden()`] or a xref:ugvw.adoc#_ugvw_layout_file-based[file-based layout] such that the property can be hidden at the view layer. Both options are provided with a view that in the future the view-layer semantics may be under the control of (expert) users, whereas domain-layer semantics should never be overridden or modified by the user. ==== @@ -58,7 +58,7 @@ The property should be hidden when displayed as a column of a table, either an o + The property should not be hidden, overriding any other metadata/conventions that would normally cause the property to be hidden. + -For example, if a property is annotated with xref:rgant.adoc#_rgant-Title[`@Title`], then normally this should be hidden from all +For example, if a property is annotated with xref:../rgant/rgant.adoc#_rgant-Title[`@Title`], then normally this should be hidden from all tables. Annotating with `@Property(where=Where.NOWHERE)` overrides this. http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PropertyLayout_labelPosition.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PropertyLayout_labelPosition.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PropertyLayout_labelPosition.adoc index 939ac6d..0b5a843 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PropertyLayout_labelPosition.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PropertyLayout_labelPosition.adoc @@ -7,9 +7,9 @@ -The `labelPosition()` attribute determines the positioning of labels for properties. This attribute can also be specified for xref:rgant.adoc#_rgant-ParameterLayout_labelPosition[parameters]. +The `labelPosition()` attribute determines the positioning of labels for properties. This attribute can also be specified for xref:../rgant/rgant.adoc#_rgant-ParameterLayout_labelPosition[parameters]. -The positioning of labels is typically `LEFT`, but can be positioned to the `TOP`. The one exception is xref:rgant.adoc#_rgant-ParameterLayout_multiLine[`multiLine()`] string properties, where the label defaults to `TOP` automatically (to provide as much real-estate for the multiline text field as possible). +The positioning of labels is typically `LEFT`, but can be positioned to the `TOP`. The one exception is xref:../rgant/rgant.adoc#_rgant-ParameterLayout_multiLine[`multiLine()`] string properties, where the label defaults to `TOP` automatically (to provide as much real-estate for the multiline text field as possible). For boolean properties a positioning of `RIGHT` is also allowed; this is ignored for all other types. @@ -77,7 +77,7 @@ can be used instead, eg: ==== 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. -Instead, a default can be specified using a xref:rgcfg.adoc#_rgcfg_configuring-core[configuration property] in `isis.properties`: +Instead, a default can be specified using a xref:../rgcfg/rgcfg.adoc#_rgcfg_configuring-core[configuration property] in `isis.properties`: [source,ini] ---- http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PropertyLayout_multiLine.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PropertyLayout_multiLine.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PropertyLayout_multiLine.adoc index 5400aa9..57da035 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PropertyLayout_multiLine.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PropertyLayout_multiLine.adoc @@ -5,7 +5,7 @@ :_imagesdir: images/ -The `multiLine()` attribute specifies that the text field for a string property should span multiple lines. It is ignored for other property types. The attribute is also supported for xref:rgant.adoc#_rgant-ParameterLayout_multiLine[parameters]. +The `multiLine()` attribute specifies that the text field for a string property should span multiple lines. It is ignored for other property types. The attribute is also supported for xref:../rgant/rgant.adoc#_rgant-ParameterLayout_multiLine[parameters]. For example: @@ -40,5 +40,5 @@ can be used instead, eg: [NOTE] ==== -If set > 1 (as would normally be the case), then the default xref:rgant.adoc#_rgant-PropertyLayout_labelPosition[`labelPosition`] defaults to `TOP` (rather than `LEFT`, as would normally be the case). +If set > 1 (as would normally be the case), then the default xref:../rgant/rgant.adoc#_rgant-PropertyLayout_labelPosition[`labelPosition`] defaults to `TOP` (rather than `LEFT`, as would normally be the case). ==== http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PropertyLayout_named.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PropertyLayout_named.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PropertyLayout_named.adoc index a8516f7..5cef62f 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PropertyLayout_named.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PropertyLayout_named.adoc @@ -5,7 +5,7 @@ :_imagesdir: images/ -The `named()` attribute explicitly specifies the property's name, overriding the name that would normally be inferred from the Java source code. This attribute can also be specified for xref:rgant.adoc#_rgant-ActionLayout_named[actions], xref:rgant.adoc#_rgant-CollectionLayout_named[collections], xref:rgant.adoc#_rgant-ParameterLayout_named[parameters], xref:rgant.adoc#_rgant-DomainObjectLayout_named[domain objects], xref:rgant.adoc#_rgant-ViewModelLayout_named[view models] and xref:rgant.adoc#_rgant-DomainServiceLayout_named[domain services]. +The `named()` attribute explicitly specifies the property's name, overriding the name that would normally be inferred from the Java source code. This attribute can also be specified for xref:../rgant/rgant.adoc#_rgant-ActionLayout_named[actions], xref:../rgant/rgant.adoc#_rgant-CollectionLayout_named[collections], xref:../rgant/rgant.adoc#_rgant-ParameterLayout_named[parameters], xref:../rgant/rgant.adoc#_rgant-DomainObjectLayout_named[domain objects], xref:../rgant/rgant.adoc#_rgant-ViewModelLayout_named[view models] and xref:../rgant/rgant.adoc#_rgant-DomainServiceLayout_named[domain services]. [TIP] ==== http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PropertyLayout_renderedAsDayBefore.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PropertyLayout_renderedAsDayBefore.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PropertyLayout_renderedAsDayBefore.adoc index af517f2..f4451af 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PropertyLayout_renderedAsDayBefore.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PropertyLayout_renderedAsDayBefore.adoc @@ -6,7 +6,7 @@ -The `renderedAsDayBefore()` attribute applies only to date properties whereby the date will be rendered as the day before the value actually held in the domain object. It is ignored for properties of other types. This attribute is also supported for xref:rgant.adoc#_rgant-ParameterLayout_renderedAsDayBefore[parameters]. +The `renderedAsDayBefore()` attribute applies only to date properties whereby the date will be rendered as the day before the value actually held in the domain object. It is ignored for properties of other types. This attribute is also supported for xref:../rgant/rgant.adoc#_rgant-ParameterLayout_renderedAsDayBefore[parameters]. This behaviour might at first glance appear odd, but the rationale is to support the use case of a sequence of instances that represent adjacent intervals of time. In such cases there would typically be `startDate` and `endDate` properties, eg for all of Q2. Storing this as a half-closed interval -- eg `[1-Apr-2015, 1-July-2015)` -- can substantially simplify internal algorithms; the `endDate` of one interval will correspond to the `startDate` of the next. http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PropertyLayout_typicalLength.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PropertyLayout_typicalLength.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PropertyLayout_typicalLength.adoc index 647957b..0d51135 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PropertyLayout_typicalLength.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PropertyLayout_typicalLength.adoc @@ -6,7 +6,7 @@ -The `typicalLength()` attribute indicates the typical length of a string property. It is ignored for properties of other types. The attribute is also supported for xref:rgant.adoc#_rgant-ParameterLayout_typicalLength[parameters]. +The `typicalLength()` attribute indicates the typical length of a string property. It is ignored for properties of other types. The attribute is also supported for xref:../rgant/rgant.adoc#_rgant-ParameterLayout_typicalLength[parameters]. The information is intended as a hint to the UI to determine the space that should be given to render a particular string property. That said, note that the xref:ugvw.adoc#[Wicket viewer] uses the maximum space available for all fields, so in effect ignores this attribute. http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_domainEvent.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_domainEvent.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_domainEvent.adoc index 9be1d74..75ca7fb 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_domainEvent.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_domainEvent.adoc @@ -13,7 +13,7 @@ Whenever a domain object (or list of domain objects) is to be rendered, the fram * pre-execute phase: before the modification of the property * post-execute: after the modification of the property -Subscribers subscribe through the xref:rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] using either link:https://github.com/google/guava[Guava] or link:http://www.axonframework.org/[Axon Framework] annotations and can influence each of these phases. +Subscribers subscribe through the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] using either link:https://github.com/google/guava[Guava] or link:http://www.axonframework.org/[Axon Framework] annotations and can influence each of these phases. By default the event raised is `PropertyDomainEvent.Default`. For example: @@ -28,8 +28,8 @@ public class ToDoItem { The `domainEvent()` attribute allows a custom subclass to be emitted allowing more precise subscriptions (to those subclasses) to be defined instead. This attribute is also supported for - xref:rgant.adoc#_rgant-Action_domainEvent[actions] and - xref:rgant.adoc#_rgant-Property_domainEvent[properties]. + xref:../rgant/rgant.adoc#_rgant-Action_domainEvent[actions] and + xref:../rgant/rgant.adoc#_rgant-Property_domainEvent[properties]. For example: @@ -56,7 +56,7 @@ rather than through the constructor. This substantially reduces the boilerplate == Subscribers -Subscribers (which must be domain services) subscribe using either the link:https://github.com/google/guava[Guava] API or (if the xref:rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] has been appropriately configured) using the link:http://www.axonframework.org/[Axon Framework] API. The examples below use the Guava API. +Subscribers (which must be domain services) subscribe using either the link:https://github.com/google/guava[Guava] API or (if the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] has been appropriately configured) using the link:http://www.axonframework.org/[Axon Framework] API. The examples below use the Guava API. Subscribers can be either coarse-grained (if they subscribe to the top-level event type): @@ -150,5 +150,5 @@ then no event will be posted. == 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 xref:rgsvc.adoc#_rgsvc_api_WrapperFactory[`WrapperFactory`] service. +wrapping the target object using the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_WrapperFactory[`WrapperFactory`] service. http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_editing.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_editing.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_editing.adoc index d914c48..2740d17 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_editing.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_editing.adoc @@ -5,19 +5,19 @@ :_imagesdir: images/ -The `editing()` attribute can be used to prevent a property from being modified or cleared, ie to make it read-only. This attribute can also be specified for xref:rgant.adoc#_rgant-Collection_editing[collections], and can also be specified for the xref:rgant.adoc#_rgant-DomainObject_editing[domain object]. +The `editing()` attribute can be used to prevent a property from being modified or cleared, ie to make it read-only. This attribute can also be specified for xref:../rgant/rgant.adoc#_rgant-Collection_editing[collections], and can also be specified for the xref:../rgant/rgant.adoc#_rgant-DomainObject_editing[domain object]. The related `editingDisabledReason()` attribute specifies the a hard-coded reason why the property cannot be modified directly. Whether a property is enabled or disabled depends upon these factors: -* whether the domain object has been configured as immutable through the xref:rgant.adoc#_rgant-DomainObject_editing[`@DomainObject#editing()`] attribute +* whether the domain object has been configured as immutable through the xref:../rgant/rgant.adoc#_rgant-DomainObject_editing[`@DomainObject#editing()`] attribute -* else (that is, if the domain object's editability is specified as being `AS_CONFIGURED`), then the value of the xref:rgcfg.adoc#_rgcfg_configuring-core[configuration property] `isis.objects.editing`. If set to `false`, then the object's properties (and collections) are _not_ editable +* else (that is, if the domain object's editability is specified as being `AS_CONFIGURED`), then the value of the xref:../rgcfg/rgcfg.adoc#_rgcfg_configuring-core[configuration property] `isis.objects.editing`. If set to `false`, then the object's properties (and collections) are _not_ editable * else, then the value of the `@Property(editing=...)` attribute itself -* else, the result of invoking any supporting xref:rgcms.adoc#_rgcms_methods_prefixes_disable[`disable...()`] supporting methods +* else, the result of invoking any supporting xref:../rgcms/rgcms.adoc#_rgcms_methods_prefixes_disable[`disable...()`] supporting methods Thus, to make a property read-only even if the object would otherwise be editable, use: http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_fileAccept.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_fileAccept.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_fileAccept.adoc index d73e923..2d45412 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_fileAccept.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_fileAccept.adoc @@ -6,9 +6,9 @@ -The `fileAccept()` attribute applies only to xref:rgcms.adoc#_rgcms_classes_value-types_Blob[`Blob`] -or xref:rgcms.adoc#_rgcms_classes_value-types_Clob[`Clob`] parameters, indicating the type of file to accept when -uploading a new value. The attribute is also supported on xref:rgant.adoc#_rgant-Parameter_fileAccept[parameters]. +The `fileAccept()` attribute applies only to xref:../rgcms/rgcms.adoc#_rgcms_classes_value-types_Blob[`Blob`] +or xref:../rgcms/rgcms.adoc#_rgcms_classes_value-types_Clob[`Clob`] parameters, indicating the type of file to accept when +uploading a new value. The attribute is also supported on xref:../rgant/rgant.adoc#_rgant-Parameter_fileAccept[parameters]. For example: http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_hidden.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_hidden.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_hidden.adoc index 4384bc2..71a7461 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_hidden.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_hidden.adoc @@ -6,11 +6,11 @@ -Properties can be hidden at the domain-level, indicating that they are not visible to the end-user. This attribute can also be applied to xref:rgant.adoc#_rgant-ActionLayout_hidden[actions] and xref:rgant.adoc#_rgant-CollectionLayout_hidden[collections]. +Properties can be hidden at the domain-level, indicating that they are not visible to the end-user. This attribute can also be applied to xref:../rgant/rgant.adoc#_rgant-ActionLayout_hidden[actions] and xref:../rgant/rgant.adoc#_rgant-CollectionLayout_hidden[collections]. [TIP] ==== -It is also possible to use xref:rgant.adoc#_rgant-Property_hidden[`@Property#hidden()`] to hide an action at the domain layer. Both options are provided with a view that in the future the view-layer semantics may be under the control of (expert) users, whereas domain-layer semantics should never be overridden or modified by the user. +It is also possible to use xref:../rgant/rgant.adoc#_rgant-Property_hidden[`@Property#hidden()`] to hide an action at the domain layer. Both options are provided with a view that in the future the view-layer semantics may be under the control of (expert) users, whereas domain-layer semantics should never be overridden or modified by the user. ==== For example: @@ -56,7 +56,7 @@ The property should be hidden when displayed as a column of a table, either an o + The property should not be hidden, overriding any other metadata/conventions that would normally cause the property to be hidden. + -For example, if a property is annotated with xref:rgant.adoc#_rgant-Title[`@Title`], then normally this should be hidden from all +For example, if a property is annotated with xref:../rgant/rgant.adoc#_rgant-Title[`@Title`], then normally this should be hidden from all tables. Annotating with `@Property(where=Where.NOWHERE)` overrides this. http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_maxLength.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_maxLength.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_maxLength.adoc index 37b93ec..1cfceae 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_maxLength.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_maxLength.adoc @@ -6,10 +6,10 @@ -The `maxLength()` attribute applies only to `String` properties, indicating the maximum number of characters that the user may enter (for example in a text field in the UI). The attribute It is ignored if applied to properties of any other type. This attribute can also be applied to xref:rgant.adoc#_rgant-Parameter_maxLength[parameters]. +The `maxLength()` attribute applies only to `String` properties, indicating the maximum number of characters that the user may enter (for example in a text field in the UI). The attribute It is ignored if applied to properties of any other type. This attribute can also be applied to xref:../rgant/rgant.adoc#_rgant-Parameter_maxLength[parameters]. -That said, properties are most commonly defined on persistent domain objects (entities), in which case the JDO xref:rgant.adoc#_rgant-Column[`@Column`] will in any case need to be specified. Apache Isis can infer the `maxLength` semantic directly from the equivalent `@Column#length()` annotation/attribute. +That said, properties are most commonly defined on persistent domain objects (entities), in which case the JDO xref:../rgant/rgant.adoc#_rgant-Column[`@Column`] will in any case need to be specified. Apache Isis can infer the `maxLength` semantic directly from the equivalent `@Column#length()` annotation/attribute. For example: http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_mustSatisfy.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_mustSatisfy.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_mustSatisfy.adoc index e88ca71..6ac65b6 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_mustSatisfy.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_mustSatisfy.adoc @@ -8,11 +8,11 @@ The `mustSatisfy()` attribute allows arbitrary validation to be applied to properties using an (implementation of a) `org.apache.isis.applib.spec.Specification` object. - The attribute is also supported on xref:rgant.adoc#_rgant-Parameter_mustSatisfy[parameters]. + The attribute is also supported on xref:../rgant/rgant.adoc#_rgant-Parameter_mustSatisfy[parameters]. [TIP] ==== -The specification implementations can (of course) be reused between properties and xref:rgant.adoc#_rgant-Parameter_mustSatisfy[parameters]. +The specification implementations can (of course) be reused between properties and xref:../rgant/rgant.adoc#_rgant-Parameter_mustSatisfy[parameters]. ==== The `Specification` is consulted during validation, being passed the proposed value. If the proposed value fails, then the value returned is the used as the invalidity reason. http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_notPersisted.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_notPersisted.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_notPersisted.adoc index 7bde4bf..b47eb39 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_notPersisted.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_notPersisted.adoc @@ -7,7 +7,7 @@ -The (somewhat misnamed) `notPersisted()` attribute indicates that the collection should be excluded from any snapshots generated by the xref:rgsvc.adoc#_rgsvc_api_XmlSnapshotService[`XmlSnapshotService`]. This attribute is also supported for xref:rgant.adoc#_rgant-Collection_notPersisted[collections]. +The (somewhat misnamed) `notPersisted()` attribute indicates that the collection should be excluded from any snapshots generated by the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_XmlSnapshotService[`XmlSnapshotService`]. This attribute is also supported for xref:../rgant/rgant.adoc#_rgant-Collection_notPersisted[collections]. [WARNING] http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_optionality.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_optionality.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_optionality.adoc index 1713bb4..a01c409 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_optionality.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_optionality.adoc @@ -8,11 +8,11 @@ -By default, Apache Isis assumes that all properties of an domain object or view model are required (mandatory). The `optionality()` attribute allows this to be relaxed. The attribute is also supported for xref:rgant.adoc#_rgant-Parameter_optionality[parameters]. +By default, Apache Isis assumes that all properties of an domain object or view model are required (mandatory). The `optionality()` attribute allows this to be relaxed. The attribute is also supported for xref:../rgant/rgant.adoc#_rgant-Parameter_optionality[parameters]. -That said, properties are most commonly defined on persistent domain objects (entities), in which case the JDO xref:rgant.adoc#_rgant-Column[`@Column`] should be specified. Apache Isis can infer the maxLength directly from the equivalent @Column#length() annotation. +That said, properties are most commonly defined on persistent domain objects (entities), in which case the JDO xref:../rgant/rgant.adoc#_rgant-Column[`@Column`] should be specified. Apache Isis can infer the maxLength directly from the equivalent @Column#length() annotation. -That said, properties are most commonly defined on persistent domain objects (entities), in which case the JDO xref:rgant.adoc#_rgant-Column[`@Column`] will in any case need to be specified. Apache Isis can infer the `optionality` semantic directly from the equivalent `@Column#allowsNull()` annotation/attribute. +That said, properties are most commonly defined on persistent domain objects (entities), in which case the JDO xref:../rgant/rgant.adoc#_rgant-Column[`@Column`] will in any case need to be specified. Apache Isis can infer the `optionality` semantic directly from the equivalent `@Column#allowsNull()` annotation/attribute. For example: @@ -129,6 +129,6 @@ public class Customer { [NOTE] ==== -It is also possible to specify optionality using xref:rgant.adoc#_rgant_Nullable[`@Nullable`] annotation. +It is also possible to specify optionality using xref:../rgant/rgant.adoc#_rgant_Nullable[`@Nullable`] annotation. ==== http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_publishing.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_publishing.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_publishing.adoc index db0ae15..1ccb708 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_publishing.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_publishing.adoc @@ -8,15 +8,15 @@ The `publishing()` attribute determines whether and how a property edit is published via the registered implementation -of a xref:rgsvc.adoc#_rgsvc_spi_PublishingService[`PublishingService`]) or -xref:rgsvc.adoc#_rgsvc_spi_PublisherService[`PublisherService`]. This attribute is also supported -for xref:rgant.adoc#_rgant-DomainObject_publishing[domain objects], where it controls whether changed objects are -published as events, and for xref:rgant.adoc#_rgant_Property_publishing[`@Property#publishing()`], where it controls +of a xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_PublishingService[`PublishingService`]) or +xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_PublisherService[`PublisherService`]. This attribute is also supported +for xref:../rgant/rgant.adoc#_rgant-DomainObject_publishing[domain objects], where it controls whether changed objects are +published as events, and for xref:../rgant/rgant.adoc#_rgant_Property_publishing[`@Property#publishing()`], where it controls whether property edits are published as events. A common use case is to notify external "downstream" systems of changes in the state of the Isis application. The default value for the attribute is `AS_CONFIGURED`, meaning that the -xref:rgcfg.adoc#_rgcfg_configuring-core[configuration property] `isis.services.publish.properties` is used to +xref:../rgcfg/rgcfg.adoc#_rgcfg_configuring-core[configuration property] `isis.services.publish.properties` is used to determine the whether the property is published: * `all` + http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_regexPattern.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_regexPattern.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_regexPattern.adoc index 279cdce..bad33cc 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_regexPattern.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_regexPattern.adoc @@ -8,7 +8,7 @@ There are three attributes related to enforcing regular expressions: -* The `regexPattern()` attribute validates the contents of any string property with respect to a regular expression pattern. It is ignored if applied to properties of any other type. This attribute can also be specified for xref:rgant.adoc#_rgant-Parameter_regexPattern[parameters]. +* The `regexPattern()` attribute validates the contents of any string property with respect to a regular expression pattern. It is ignored if applied to properties of any other type. This attribute can also be specified for xref:../rgant/rgant.adoc#_rgant-Parameter_regexPattern[parameters]. * The `regexPatternFlags()` attribute specifies flags that modify the handling of the pattern. The values are those that would normally be passed to `java.util.regex.Pattern#compile(String,int)`. http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-RequestScoped.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-RequestScoped.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-RequestScoped.adoc index 7372d56..11c8fe1 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-RequestScoped.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-RequestScoped.adoc @@ -7,11 +7,11 @@ -The `@javax.enterprise.context.RequestScoped` link:https://jcp.org/en/jsr/detail?id=299[JSR-299] CDI annotation is used to specify that a xref:rgant.adoc#_rgant-DomainService[domain service] should be request-scoped rather than a singleton. +The `@javax.enterprise.context.RequestScoped` link:https://jcp.org/en/jsr/detail?id=299[JSR-299] CDI annotation is used to specify that a xref:../rgant/rgant.adoc#_rgant-DomainService[domain service] should be request-scoped rather than a singleton. Although Apache Isis does not (currently) leverage CDI, the semantics are the same as request-scoped service; a new instance is created for each HTTP request, reserved for the exclusive use of all objects interacted with during that request. -One of the built-in domain services that uses this annotation is xref:rgsvc.adoc#_rgsvc_api_Scratchpad[`Scratchpad`], intended to allow the arbitrary sharing of data between objects. Here is the full source code of this service is: +One of the built-in domain services that uses this annotation is xref:../rgsvc/rgsvc.adoc#_rgsvc_api_Scratchpad[`Scratchpad`], intended to allow the arbitrary sharing of data between objects. Here is the full source code of this service is: [source,java] http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Title.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Title.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Title.adoc index 0b92462..0abf793 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Title.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Title.adoc @@ -40,7 +40,7 @@ present in the title column. This convention can be overridden using == Lombok support -If xref:dg.adoc#_dg_ide_project-lombok[Project Lombok] is being used, then `@Title` can be specified on the backing field. +If xref:../dg/dg.adoc#_dg_ide_project-lombok[Project Lombok] is being used, then `@Title` can be specified on the backing field. For example:
