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 2017/03/31 07:11:15 UTC
[39/51] [partial] isis git commit: ISIS-1521: reorganizes asciidoc
documentation, moves into subdirs (both guides and other pages)
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/adocs/documentation/src/main/asciidoc/guides/_rgant-NotPersistent.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgant-NotPersistent.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgant-NotPersistent.adoc
deleted file mode 100644
index 042c4b3..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgant-NotPersistent.adoc
+++ /dev/null
@@ -1,18 +0,0 @@
-[[_rgant-NotPersistent]]
-= `@NotPersistent` (`javax.jdo`)
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-:_basedir: ../
-:_imagesdir: images/
-
-
-The `@javax.jdo.annotation.NotPersistent` annotation is used by JDO/DataNucleus to indicate that a property should not be persisted to the database.
-
-Apache Isis also uses this annotation, though (currently) only in the very minimal way to suppress checking of inconsistent metadata between JDO and Isis annotations (eg `@Column#allowsNull()` vs `@Property#optionality()`, or `@Column#length()` and `@Property#maxLength()`).
-
-[NOTE]
-====
-Isis parses the `@NotPersistent` annotation from the Java source code; it does not query the JDO metamodel. This means that it the `@NotPersistent` annotation must be used rather than the equivalent `<field>` link:http://www.datanucleus.org/products/accessplatform_4_0/jdo/fields_properties.html[XML metadata].
-
-Moreover, while JDO/DataNucleus will recognize annotations on either the field or the getter method, Apache Isis (currently) only inspects the getter method. Therefore ensure that the annotation is placed there.
-====
-
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/adocs/documentation/src/main/asciidoc/guides/_rgant-Nullable.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgant-Nullable.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgant-Nullable.adoc
deleted file mode 100644
index 9351e0f..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgant-Nullable.adoc
+++ /dev/null
@@ -1,54 +0,0 @@
-[[_rgant-Nullable]]
-= `@Nullable` (`javax`)
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-:_basedir: ../
-:_imagesdir: images/
-
-
-Apache Isis' defaults for properties and parameters is that they are mandatory unless otherwise stated. The
-`@javax.annotation.Nullable` annotation is recognized by Apache Isis for both properties and
-parameters as means to indicate that the property/parameter is not mandatory.
-
-
-For example:
-
-[source,java]
-----
-@javax.annotation.Nullable
-public String getName() {
- return name;
-}
-public void setName(final String name) {
- this.name = name;
-}
-----
-
-or:
-
-[source,java]
-----
-public Customer updateName(@javax.annotation.Nullable final String name) {
- setName(name);
- return this;
-}
-----
-
-Apache Isis does provide several other ways to specify optionality: using the
-xref:rgant.adoc#_rgant_Property_optionality[`@Property#optionality()`] /
-xref:rgant.adoc#_rgant_Parameter_optionality[`@Parameter#optionality()`] annotation. For properties, the optionality
-can also be inferred from the xref:rgant.adoc#_rgant_Column_allowsNull[`@Column#allowsNull()`] attribute.
-
-[TIP]
-====
-See the
-xref:rgant.adoc#_rgant_Property_optionality[`@Property#optionality()`] documentation for a much fuller discussion on
-the relationship between using the Apache Isis annotations vs
-xref:rgant.adoc#_rgant_Column_allowsNull[`@Column#allowsNull()`].
-====
-
-If more than one method is specified then the framework will validate that there are no incompatibilities (and fail to
-boot otherwise). This can also be verified using the xref:rgmvn.adoc#_rgmvn_validate[validate goal] of the Apache
-Isis Maven plugin.
-
-
-
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/adocs/documentation/src/main/asciidoc/guides/_rgant-Parameter.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgant-Parameter.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgant-Parameter.adoc
deleted file mode 100644
index 16bc5f0..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgant-Parameter.adoc
+++ /dev/null
@@ -1,106 +0,0 @@
-[[_rgant-Parameter]]
-= `@Parameter`
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-:_basedir: ../
-:_imagesdir: images/
-
-
-The `@Parameter` annotation applies to action parameters collecting together all domain semantics within a single annotation.
-
-The table below summarizes the annotation's attributes.
-
-.`@Paramter` attributes
-[cols="2,2,4a", options="header"]
-|===
-
-| Attribute
-| Values (default)
-| Description
-
-
-|xref:rgant.adoc#_rgant-Parameter_fileAccept[`fileAccept()`]
-|Media type or file extension
-|Hints the file type to be uploaded for xref:rgcms.adoc#_rgcms_classes_value-types_Blob[`Blob`]
- or xref: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-Parameter_maxLength[`maxLength()`]
-|Positive integer
-|maximum number of characters for string parameters; ignored otherwise
-
-
-|`minLength()`
-|Positive integer
-|Deprecated; use xref:rgant.adoc#_rgant_minLength[`@MinLength`] instead. +
-
-Can be used to specify the minimum length for xref:rgcms.adoc#_rgcms_methods_prefixes_autoComplete[`autoComplete...()`] supporting method; but because this _is a_ supporting method rather than the action method itself, we now feel it is misleading to use the `@Parameter` annotation in this situation.
-
-
-|xref:rgant.adoc#_rgant-Parameter_mustSatisfy[`mustSatisfy()`]
-|implementation of `o.a.i.applib.spec.Specification`
-|allows arbitrary validation to be applied
-
-
-|xref:rgant.adoc#_rgant-Parameter_optionality[`optionality()`]
-|`MANDATORY`, `OPTIONAL` (`MANDATORY`)
-|specifies a parameter is optional rather than mandatory
-
-
-|xref:rgant.adoc#_rgant-Parameter_regexPattern[regexPattern()]
-|regular expression
-|validates the contents of a string parameter against the regular expression pattern
-
-
-|`regexPatternFlags()`
-|value of flags as normally passed to `java.util.regex.` +
-`Pattern#compile(...)`
-|modifies the compilation of the regular expression
-
-
-|`regexPatternReplacement()`
-|
-|Unused.
-
-
-|===
-
-
-
-
-For example:
-
-[source,java]
-----
-public class Customer {
- public static class EmailSpecification extends AbstractSpecification<String> {
- public String satisfiesSafely(String proposed) {
- return EmailUtil.ensureValidEmail(proposed); // <1>
- }
- }
- @Action(semantics=SemanticsOf.IDEMPOTENT)
- public Customer updateEmail(
- @Parameter(
- maxLength=30,
- mustSatisfy=EmailSpecification.class,
- optionality=Optionality.OPTIONAL,
- regexPattern = "(\\w+\\.)*\\w+@(\\w+\\.)+[A-Za-z]+",
- regexPatternFlags=Pattern.CASE_INSENSITIVE
- )
- @ParameterLayout(named="New Email Address")
- final String newEmailAddress
- ...
- }
-}
-----
-<1> the (fictitious) `EmailUtil.ensureValid(...)` (omitted for brevity) returns a string explaining if an email is invalid
-
-include::_rgant-Parameter_fileAccept.adoc[leveloffset=+1]
-include::_rgant-Parameter_maxLength.adoc[leveloffset=+1]
-include::_rgant-Parameter_mustSatisfy.adoc[leveloffset=+1]
-include::_rgant-Parameter_optionality.adoc[leveloffset=+1]
-include::_rgant-Parameter_regexPattern.adoc[leveloffset=+1]
-
-
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/adocs/documentation/src/main/asciidoc/guides/_rgant-ParameterLayout.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgant-ParameterLayout.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgant-ParameterLayout.adoc
deleted file mode 100644
index 1592b2c..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgant-ParameterLayout.adoc
+++ /dev/null
@@ -1,112 +0,0 @@
-[[_rgant-ParameterLayout]]
-= `@ParameterLayout`
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-:_basedir: ../
-:_imagesdir: images/
-
-
-
-The `@ParameterLayout` annotation applies to action parameters, collecting together all UI hints within a single annotation.
-
-The table below summarizes the annotation's attributes.
-
-.`@ParameterLayout` attributes
-[cols="2,2,4a", options="header"]
-|===
-
-| Attribute
-| Values (default)
-| Description
-
-
-|xref: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`]
-
-
-|xref: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()`]
-|`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.
-
-
-|xref: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`.
-
-
-|xref:rgant.adoc#_rgant-ParameterLayout_named[`named()`]
-|String
-|the name of this parameter. +
-
-For Java 7 this is generally required. For Java 8, the name can often be inferred from the code so this attribute allows the name to be overridden. A typical use case is if the desired name is a reserved Java keyword, such as `default` or `package`.
-
-
-|`namedEscaped()`
-|`true`, `false` (`true`)
-|whether to HTML escape the name of this parameter.
-
-
-|xref: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()`]
-|
-|the typical entry length of a field, use to determine the optimum width for display
-
-|===
-
-
-
-
-
-For example:
-
-[source,java]
-----
-public class ToDoItem {
- public ToDoItem updateDescription(
- @ParameterLayout(
- cssClass="x-key",
- describedAs="What needs to be done",
- labelPosition=LabelPosition.LEFT,
- named="Description of this <i>item</i>",
- namedEscaped=false,
- typicalLength=80)
- final String description) {
- setDescription(description);
- return this;
- }
- ...
-}
-----
-
-
-
-[NOTE]
-====
-Note that there is (currently) no support for specifying UI hints for domain services through the dynamic xref:ugfun.adoc#_ugfun_object-layout_dynamic[`.layout.json`] file (only for properties, collections and actions are supported).
-====
-
-
-
-include::_rgant-ParameterLayout_cssClass.adoc[leveloffset=+1]
-include::_rgant-ParameterLayout_describedAs.adoc[leveloffset=+1]
-include::_rgant-ParameterLayout_labelPosition.adoc[leveloffset=+1]
-include::_rgant-ParameterLayout_multiLine.adoc[leveloffset=+1]
-include::_rgant-ParameterLayout_named.adoc[leveloffset=+1]
-include::_rgant-ParameterLayout_renderedAsDayBefore.adoc[leveloffset=+1]
-include::_rgant-ParameterLayout_typicalLength.adoc[leveloffset=+1]
-
-
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/adocs/documentation/src/main/asciidoc/guides/_rgant-ParameterLayout_cssClass.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgant-ParameterLayout_cssClass.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgant-ParameterLayout_cssClass.adoc
deleted file mode 100644
index b5aa6f9..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgant-ParameterLayout_cssClass.adoc
+++ /dev/null
@@ -1,29 +0,0 @@
-[[_rgant-ParameterLayout_cssClass]]
-= `cssClass()`
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-:_basedir: ../
-:_imagesdir: images/
-
-
-
-
-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.
-
-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].
-
-For example:
-
-[source,java]
-----
-public class ToDoItem {
- public ToDoItem postpone(
- @ParameterLayout(
- named="until",
- cssClass="x-key"
- )
- LocalDate until
- ) { ... }
- ...
-}
-----
-
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/adocs/documentation/src/main/asciidoc/guides/_rgant-ParameterLayout_describedAs.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgant-ParameterLayout_describedAs.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgant-ParameterLayout_describedAs.adoc
deleted file mode 100644
index eaef642..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgant-ParameterLayout_describedAs.adoc
+++ /dev/null
@@ -1,38 +0,0 @@
-[[_rgant-ParameterLayout_describedAs]]
-= `describedAs()`
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-:_basedir: ../
-:_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].
-
-Descriptions may be provided for objects, members (properties,
-collections and actions), and for individual parameters within an action
-method. `@DescribedAs` therefore works in a very similar manner to
-`@Named` <!--(see ?)-->.
-
-
-To provide a description for an individual action parameter, use the
-`@DescribedAs` annotation in-line i.e. immediately before the parameter
-declaration.
-
-For example:
-
-[source,java]
-----
-public class Customer {
- public Order placeOrder(
- Product product,
- @ParameterLayout(
- named="Quantity",
- describedAs="The quantity of the product being ordered"
- )
- int quantity) {
- ...
- }
- ...
-}
-----
-
-
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/adocs/documentation/src/main/asciidoc/guides/_rgant-ParameterLayout_labelPosition.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgant-ParameterLayout_labelPosition.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgant-ParameterLayout_labelPosition.adoc
deleted file mode 100644
index 3869e92..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgant-ParameterLayout_labelPosition.adoc
+++ /dev/null
@@ -1,41 +0,0 @@
-[[_rgant-ParameterLayout_labelPosition]]
-= `labelPosition()`
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-:_basedir: ../
-:_imagesdir: images/
-
-
-
-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 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).
-
-For boolean parameters a positioning of `RIGHT` is also allowed; this is ignored for all other types.
-
-It is also possible to suppress the label altogether, using `NONE`.
-
-For example:
-
-[source,java]
-----
-public class Order {
- public Order changeStatus(
- OrderStatus newStatus
- @Parameter(
- optionality=Optionality.OPTIONAL
- )
- @ParameterLayout(
- named="Reason",
- labelPosition=LabelPosition.TOP
- )
- String reason) {
- ...
- }
- ...
-}
-----
-
-
-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()].
-
-
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/adocs/documentation/src/main/asciidoc/guides/_rgant-ParameterLayout_multiLine.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgant-ParameterLayout_multiLine.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgant-ParameterLayout_multiLine.adoc
deleted file mode 100644
index 64b5803..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgant-ParameterLayout_multiLine.adoc
+++ /dev/null
@@ -1,32 +0,0 @@
-[[_rgant-ParameterLayout_multiLine]]
-= `multiLine()`
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-:_basedir: ../
-:_imagesdir: images/
-
-
-
-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].
-
-For example:
-
-[source,java]
-----
-public class BugReport {
- public BugReport updateStepsToReproduce(
- @Parameter(named="Steps")
- @ParameterLayout(
- numberOfLines=10
- )
- final String steps) {
- ...
- }
- ...
-}
-----
-
-[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).
-====
-
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/adocs/documentation/src/main/asciidoc/guides/_rgant-ParameterLayout_named.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgant-ParameterLayout_named.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgant-ParameterLayout_named.adoc
deleted file mode 100644
index f870e85..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgant-ParameterLayout_named.adoc
+++ /dev/null
@@ -1,44 +0,0 @@
-[[_rgant-ParameterLayout_named]]
-= `named()`
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-:_basedir: ../
-:_imagesdir: images/
-
-
-
-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].
-
-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.
-
-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.
-
-
-
-By default the name is HTML escaped. To allow HTML markup, set the related `namedEscaped()` attribute to `false`.
-
-For example:
-
-[source,java]
-----
-public class Customer {
- public Order placeOrder(
- final Product product
- ,@ParameterLayout(named="Quantity")
- final int quantity) {
- Order order = newTransientInstance(Order.class);
- order.modifyCustomer(this);
- order.modifyProduct(product);
- order.setQuantity(quantity);
- return order;
- }
- ...
-}
-----
-
-
-[TIP]
-====
-The framework also provides a separate, powerful mechanism for xref:ugbtb.adoc#_ugbtb_i18n[internationalization].
-====
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/adocs/documentation/src/main/asciidoc/guides/_rgant-ParameterLayout_renderedAsDayBefore.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgant-ParameterLayout_renderedAsDayBefore.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgant-ParameterLayout_renderedAsDayBefore.adoc
deleted file mode 100644
index 1c04eb0..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgant-ParameterLayout_renderedAsDayBefore.adoc
+++ /dev/null
@@ -1,35 +0,0 @@
-[[_rgant-ParameterLayout_renderedAsDayBefore]]
-= `renderedAsDayBefore()`
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-:_basedir: ../
-:_imagesdir: images/
-
-
-
-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].
-
-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.
-
-However, from an end-user perspective the requirement may be to render the interval as a fully closed interval; eg the end date should be shown as `30-Jun-2015`.
-
-This attribute therefore bridges the gap; it presents the information in a way that makes sense to an end-user, but also stores the domain object in a way that is easy work with internally.
-
-For example:
-
-[source,java]
-----
-public class Tenancy {
- public void changeDates(
- @ParameterLayout(named="Start Date")
- LocalDate startDate,
- @ParameterLayout(
- named="End Date",
- renderedAsDayBefore=true
- )
- LocalDate endDate) {
- ...
- }
-}
-----
-
-
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/adocs/documentation/src/main/asciidoc/guides/_rgant-ParameterLayout_typicalLength.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgant-ParameterLayout_typicalLength.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgant-ParameterLayout_typicalLength.adoc
deleted file mode 100644
index db0ab10..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgant-ParameterLayout_typicalLength.adoc
+++ /dev/null
@@ -1,36 +0,0 @@
-[[_rgant-ParameterLayout_typicalLength]]
-= `typicalLength()`
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-:_basedir: ../
-:_imagesdir: images/
-
-
-
-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 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.
-
-For example:
-
-[source,java]
-----
-public class Customer {
- public Customer updateName(
- @Parameter(maxLength=30)
- @ParameterLayout(
- named="First name",
- typicalLength=20
- )
- final String firstName,
- @Parameter(maxLength=30)
- @ParameterLayout(
- named="Last name",
- typicalLength=20
- )
- final String lastName) {
- ...
- }
- ...
-}
-----
-
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/adocs/documentation/src/main/asciidoc/guides/_rgant-Parameter_fileAccept.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgant-Parameter_fileAccept.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgant-Parameter_fileAccept.adoc
deleted file mode 100644
index 54d8d7b..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgant-Parameter_fileAccept.adoc
+++ /dev/null
@@ -1,37 +0,0 @@
-[[_rgant-Parameter_fileAccept]]
-= `fileAccept()`
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-:_basedir: ../
-:_imagesdir: images/
-
-
-
-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].
-
-For example:
-
-[source,java]
-----
-public class Scanner {
- public ScannedDocument newScan(
- @Parameter(fileAccept="image/*") // <1>
- @ParameterLayout(named="Scanned image") // <2>
- final Blob scannedImage) {
- ...
- }
-}
-----
-<1> as per link:http://www.w3schools.com/tags/att_input_accept.asp[reference docs], either a media type (such as
-`image/*`) or a file type extension (such as `.png`).
-<2> the `@ParameterLayout(named=...)` attribute is required for Java 7; for Java 8 it can be omitted if the
-(non-ASF) http://github.com/isisaddons/isis-metamodel-paraname8[Isis addons' paraname8] metamodel extension is used.
-
-
-
-
-
-
-
-
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/adocs/documentation/src/main/asciidoc/guides/_rgant-Parameter_maxLength.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgant-Parameter_maxLength.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgant-Parameter_maxLength.adoc
deleted file mode 100644
index 1dfae36..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgant-Parameter_maxLength.adoc
+++ /dev/null
@@ -1,35 +0,0 @@
-[[_rgant-Parameter_maxLength]]
-= `maxLength()`
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-:_basedir: ../
-:_imagesdir: images/
-
-
-
-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].
-
-For example:
-
-[source,java]
-----
-public class CustomerRepository {
- public Customer newCustomer(
- @Parameter(maxLength=30)
- @ParameterLayout(named="First Name") // <1>
- final String firstName,
- @Parameter(maxLength=50)
- @ParameterLayout(named="Last Name")
- final String lastName) {
- ...
- }
-}
-----
-<1> the `@ParameterLayout(named=...)` attribute is required for Java 7; for Java 8 it can be omitted if the (non-ASF) http://github.com/isisaddons/isis-metamodel-paraname8[Isis addons' paraname8] metamodel extension is used.
-
-
-
-
-
-
-
-
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/adocs/documentation/src/main/asciidoc/guides/_rgant-Parameter_mustSatisfy.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgant-Parameter_mustSatisfy.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgant-Parameter_mustSatisfy.adoc
deleted file mode 100644
index e845f31..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgant-Parameter_mustSatisfy.adoc
+++ /dev/null
@@ -1,65 +0,0 @@
-[[_rgant-Parameter_mustSatisfy]]
-= `mustSatisfy()`
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-:_basedir: ../
-:_imagesdir: images/
-
-
-
-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].
-
-[TIP]
-====
-The specification implementations can (of course) be reused between parameters and xref: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.
-
-For example:
-
-[source,java]
-----
-public class StartWithCapitalLetterSpecification
- extends AbstractSpecification<String> { // <1>
- public String satisfiesSafely(String proposed) {
- return "".equals(proposed)
- ? "Empty string"
- : !Character.isUpperCase(proposed.charAt(0))
- ? "Does not start with a capital letter"
- : null;
- }
-}
-public class CustomerRepository {
- public Customer newCustomer(
- @Parameter(
- mustSatisfy=StartWithCapitalLetterSpecification.class
- )
- @ParameterLayout(named="First Name")
- final String firstName,
- @Parameter(
- mustSatisfy=StartWithCapitalLetterSpecification.class
- )
- @ParameterLayout(named="Last Name")
- final String lastName) {
- ...
- }
- ...
-}
-----
-<1> the `AbstractSpecification` class conveniently handles type-safety and dealing with null values. The applib also provides `SpecificationAnd` and `SpecificationOr` to allow specifications to be combined "algebraically".
-
-
-It is also possible to provide translatable reasons. Rather than implement `Specification`, instead implement `Specification2` which defines the API:
-
-[source,java]
-----
-public interface Specification2 extends Specification {
- public TranslatableString satisfiesTranslatable(Object obj); // <1>
-}
-----
-<1> Return `null` if specification satisfied, otherwise the reason as a translatable string
-
-With `Specification2` there is no need to implement the inherited `satifies(Object)`; that method will never be called.
-
-
-
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/adocs/documentation/src/main/asciidoc/guides/_rgant-Parameter_optionality.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgant-Parameter_optionality.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgant-Parameter_optionality.adoc
deleted file mode 100644
index 7ad83bd..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgant-Parameter_optionality.adoc
+++ /dev/null
@@ -1,42 +0,0 @@
-[[_rgant-Parameter_optionality]]
-= `optionality()`
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-:_basedir: ../
-:_imagesdir: images/
-
-
-
-
-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].
-
-
-[TIP]
-====
-The attribute has no meaning for a primitive type such as `int`: primitives will always have a default value (e.g. zero). If optionality is required, then use the corresponding wrapper class (e.g. `java.lang.Integer`) and annotate with `Parameter#optionality()` as required.
-====
-
-The values for the attribute are simply `OPTIONAL` or `MANDATORY`.
-
-For example:
-
-[source,java]
-----
-public class Customer {
- public Order placeOrder(
- final Product product,
- @ParameterLayout(named = "Quantity")
- final int quantity,
- @Parameter(optionality = Optionality.OPTIONAL)
- @ParameterLayout(named = "Special Instructions")
- final String instr) {
- ...
- }
- ...
-}
-----
-
-
-[NOTE]
-====
-It is also possible to specify optionality using xref:rgant.adoc#_rgant_Nullable[`@Nullable`] annotation.
-====
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/adocs/documentation/src/main/asciidoc/guides/_rgant-Parameter_regexPattern.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgant-Parameter_regexPattern.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgant-Parameter_regexPattern.adoc
deleted file mode 100644
index 95f58f8..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgant-Parameter_regexPattern.adoc
+++ /dev/null
@@ -1,37 +0,0 @@
-[[_rgant-Parameter_regexPattern]]
-= `regexPattern()`
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-:_basedir: ../
-:_imagesdir: images/
-
-
-
-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 `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)`.
-
-* The related `regexPatternReplacement()` attribute specifies the error message to show if
-the provided argument does not match the regex pattern.
-
-For example:
-
-[source,java]
-----
-public class Customer {
- public void updateEmail(
- @Parameter(
- regexPattern = "(\\w+\\.)*\\w+@(\\w+\\.)+[A-Za-z]+",
- regexPatternFlags = Pattern.CASE_INSENSITIVE,
- regexPatternReplacement = "Must be valid email address (containing a '@') symbol" // <1>
- )
- @ParameterLayout(named = "Email")
- final String email) {
- ...
- }
-)
-----
-<1> Note that there is currently no i18n support for this phrase.
-
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/adocs/documentation/src/main/asciidoc/guides/_rgant-PersistenceCapable.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgant-PersistenceCapable.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgant-PersistenceCapable.adoc
deleted file mode 100644
index a1d01bd..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgant-PersistenceCapable.adoc
+++ /dev/null
@@ -1,104 +0,0 @@
-[[_rgant-PersistenceCapable]]
-= `@PersistenceCapable` (`javax.jdo`)
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-:_basedir: ../
-:_imagesdir: images/
-
-
-
-The `@javax.jdo.annotation.PersistenceCapable` is used by JDO/DataNucleus to indicate that a class is a domain entity to be persisted to the database.
-
-Apache Isis also checks for this annotation, and if the `@PersistenceCapable#schema()` attribute is present will use it to form the object type.
-
-[NOTE]
-====
-Isis parses the `@PersistenceCapable` annotation from the Java source code; it does not query the JDO metamodel. This means that it the `@PersistenceCapable` annotation must be used rather than the equivalent `<class>` link:http://www.datanucleus.org/products/accessplatform_4_0/jdo/class_mapping.html[XML metadata].
-
-Moreover, while JDO/DataNucleus will recognize annotations on either the field or the getter method, Apache Isis (currently) only inspects the getter method. Therefore ensure that the annotation is placed there.
-====
-
-
-This value is used internally to generate a string representation of an objects identity (the `Oid`).
-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`])
- ** 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 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`]
-
-
-The actual format of the object type used by Apache Isis for the concatenation of `schema()` and `@PersistenceCapable#table()`.
-If the `table()` is not present, then the class' simple name is used instead.
-
-
-== Examples
-
-For example:
-
-[source,java]
-----
-@javax.jdo.annotations.PersistenceCapable(schema="custmgmt")
-public class Customer {
- ...
-}
-----
-
-has an object type of `custmgmt.Customer`, while:
-
-[source,java]
-----
-@javax.jdo.annotations.PersistenceCapable(schema="custmgmt", table="Address")
-public class AddressImpl {
- ...
-}
-----
-
-has an object type of `custmgmt.Address`.
-
-
-On the other hand:
-
-[source,java]
-----
-@javax.jdo.annotations.PersistenceCapable(table="Address")
-public class AddressImpl {
- ...
-}
-----
-
-does _not_ correspond to an object type, because the `schema()` attribute is missing.
-
-
-
-== Precedence
-
-The rules of precedence for determining a domain object's object type are:
-
-1. xref:rgant.adoc#_rgant_Discriminator[`@Discriminator`]
-2. `@DomainObject#objectType`
-3. xref: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`".
-
-4. Fully qualified class name of the entity.
-
-
-[TIP]
-====
-This might be obvious, but to make explicit: we recommend that you always specify an object type for your domain objects.
-
-Otherwise, if you refactor your code (change class name or move package), then any externally held references to the OID of the object will break.
-At best this will require a data migration in the database; at worst it could cause external clients accessing data through the xref:ugvro.adoc#[Restful Objects] viewer to break.
-====
-
-
-
-
-[NOTE]
-====
-If the object type is not unique across all domain classes then the framework will fail-fast and fail to boot. An error message will be printed in the log to help you determine which classes have duplicate object tyoes.
-====
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/adocs/documentation/src/main/asciidoc/guides/_rgant-PostConstruct.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgant-PostConstruct.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgant-PostConstruct.adoc
deleted file mode 100644
index 8186d7d..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgant-PostConstruct.adoc
+++ /dev/null
@@ -1,71 +0,0 @@
-[[_rgant-PostConstruct]]
-= `@PostConstruct` (`javax`)
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-:_basedir: ../
-:_imagesdir: images/
-
-
-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`]).
-
-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.
-
-The signature of the method is:
-
-[source,java]
-----
-@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.
-<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>`:
-
-[source,java]
-----
-@PostConstruct
-@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]:
-
-[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.
-====
-
-A common use case is for domain services that interact with the xref:rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`]. For example:
-
-[source,java]
-----
-@DomainService(nature=NatureOfService.DOMAIN)
-public class MySubscribingService {
- @PostConstruct
- public void postConstruct() {
- eventBusService.register(this);
- }
- @PreDestroy
- public void preDestroy() {
- eventBusService.unregister(this);
- }
- ...
- @javax.inject.Inject
- EventBusService eventBusService;
-}
-----
-
-[TIP]
-====
-In this particular use case, it is generally simpler to just subclass from xref: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-PreDestroy[`@PreDestroy`]
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/adocs/documentation/src/main/asciidoc/guides/_rgant-PreDestroy.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgant-PreDestroy.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgant-PreDestroy.adoc
deleted file mode 100644
index ab38082..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgant-PreDestroy.adoc
+++ /dev/null
@@ -1,53 +0,0 @@
-[[_rgant-PreDestroy]]
-= `@PreDestroy` (`javax`)
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-:_basedir: ../
-:_imagesdir: images/
-
-
-
-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.
-
-The signature of the method is:
-
-[source,java]
-----
-@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.
-<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:
-
-[source,java]
-----
-@DomainService(nature=NatureOfService.DOMAIN)
-public class MySubscribingService {
- @PostConstruct
- public void init() {
- eventBusService.register(this);
- }
- @PreDestroy
- public void deinit() {
- eventBusService.unregister(this);
- }
- ...
- @javax.inject.Inject
- EventBusService eventBusService;
-}
-----
-
-[TIP]
-====
-In this particular use case, it is generally simpler to just subclass from xref: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
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/adocs/documentation/src/main/asciidoc/guides/_rgant-PrimaryKey.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgant-PrimaryKey.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgant-PrimaryKey.adoc
deleted file mode 100644
index 150d048..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgant-PrimaryKey.adoc
+++ /dev/null
@@ -1,19 +0,0 @@
-[[_rgant-PrimaryKey]]
-= `@PrimaryKey` (`javax.jdo`)
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-:_basedir: ../
-:_imagesdir: images/
-
-
-
-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).
-
-[NOTE]
-====
-Isis parses the `@NotPersistent` annotation from the Java source code; it does not query the JDO metamodel. This means that it the `@NotPersistent` annotation must be used rather than the equivalent `<field>` link:http://www.datanucleus.org/products/accessplatform_4_0/jdo/application_identity.html[XML metadata].
-
-Moreover, while JDO/DataNucleus will recognize annotations on either the field or the getter method, Apache Isis (currently) only inspects the getter method. Therefore ensure that the annotation is placed there.
-====
-
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/adocs/documentation/src/main/asciidoc/guides/_rgant-Programmatic.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgant-Programmatic.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgant-Programmatic.adoc
deleted file mode 100644
index 9b2923f..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgant-Programmatic.adoc
+++ /dev/null
@@ -1,27 +0,0 @@
-[[_rgant-Programmatic]]
-= `@Programmatic`
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-:_basedir: ../
-:_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.
-
-A common use-case is to ignore implementation-level artifacts. For example:
-
-[source,java]
-----
-public class Customer implements Comparable<Customer> {
- ...
- @Programmatic
- public int compareTo(Customer c) {
- return getSalary() - c.getSalary();
- }
- ...
-}
-----
-
-
-Note that `@Programmatic` does not simply imply `@Hidden`; it actually means that the class member will not be part of the Apache Isis metamodel.
-
-
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/adocs/documentation/src/main/asciidoc/guides/_rgant-Property.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgant-Property.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgant-Property.adoc
deleted file mode 100644
index 774741b..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgant-Property.adoc
+++ /dev/null
@@ -1,143 +0,0 @@
-[[_rgant-Property]]
-= `@Property`
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-:_basedir: ../
-:_imagesdir: images/
-
-
-The `@Property` annotation applies to properties collecting together all domain semantics within a single annotation.
-
-It is also possible to apply the annotation to actions of domain services that are acting as link:../../more-advanced-topics/how-to-01-062-How-to-decouple-dependencies-using-contributions.html[contributed properties].
-
-
-
-.`@Property` attributes
-[cols="2,2,4a", options="header"]
-|===
-
-| Attribute
-| Values (default)
-| Description
-
-
-|xref: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).
-
-
-|xref: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()`]
-|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`]. +
- +
-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()`]
-|`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()`]
-|
-|maximum number of characters for string parameters; ignored otherwise +
-
-In many/most cases you should however use xref:rgant.adoc#_rgant-Column[`@Column#length()`]
-
-
-|xref: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()`]
-|`true`, `false` +
-(`false`)
-|whether to exclude from snapshots. +
-
-[WARNING]
-====
-Property must also be annotated with `@javax.jdo.annotations.NotPersistent` in order to not be persisted.
-====
-
-
-|xref: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()`]
-
-
-
-|xref:rgant.adoc#_rgant-Property_regexPattern[`regexPattern()`]
-|regular expression
-|validates the contents of a string parameter against the regular expression pattern
-
-
-|`regexPatternFlags()`
-|value of flags as normally passed to `java.util.regex.` +
-`Pattern#compile(...)`
-|modifies the compilation of the regular expression
-
-
-|===
-
-
-For example:
-
-[source,java]
-----
-@DomainObject
-public class Customer {
- public static class EmailSpecification extends AbstractSpecification<String> {
- public String satisfiesSafely(String proposed) {
- return EmailUtil.ensureValidEmail(proposed); // <1>
- }
- }
- @javax.jdo.annotations.Column(allowsNull="true") // <2>
- @Property(
- maxLength=30,
- minLength=5,
- mustSatisfy=EmailSpecification.class,
- regexPattern = "(\\w+\\.)*\\w+@(\\w+\\.)+[A-Za-z]+",
- regexPatternFlags=Pattern.CASE_INSENSITIVE
- )
- public String getEmailAddress() { ... }
- public void setEmailAddress(String emailAddress) { ... }
- ...
-}
-----
-<1> the (fictitious) `EmailUtil.ensureValid(...)` (omitted for brevity) returns a string explaining if an email is invalid
-<2> generally use instead of the `@Property#optionality()` attribute
-
-
-
-
-
-[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
-so that boilerplate-busting tools such as link:https://projectlombok.org/[Project Lombok] can be used.
-====
-
-
-include::_rgant-Property_domainEvent.adoc[leveloffset=+1]
-include::_rgant-Property_editing.adoc[leveloffset=+1]
-include::_rgant-Property_fileAccept.adoc[leveloffset=+1]
-include::_rgant-Property_hidden.adoc[leveloffset=+1]
-include::_rgant-Property_maxLength.adoc[leveloffset=+1]
-include::_rgant-Property_mustSatisfy.adoc[leveloffset=+1]
-include::_rgant-Property_notPersisted.adoc[leveloffset=+1]
-include::_rgant-Property_optionality.adoc[leveloffset=+1]
-include::_rgant-Property_regexPattern.adoc[leveloffset=+1]
-
-
-
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/adocs/documentation/src/main/asciidoc/guides/_rgant-PropertyLayout.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgant-PropertyLayout.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgant-PropertyLayout.adoc
deleted file mode 100644
index 03f1eef..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgant-PropertyLayout.adoc
+++ /dev/null
@@ -1,142 +0,0 @@
-[[_rgant-PropertyLayout]]
-= `@PropertyLayout`
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-:_basedir: ../
-:_imagesdir: images/
-
-
-The `@PropertyLayout` annotation applies to properties collecting together all UI hints within a single annotation.
-
-
-The table below summarizes the annotation's attributes.
-
-.`@PropertyLayout` attributes
-[cols="2,2,4a", options="header"]
-|===
-
-| Attribute
-| Values (default)
-| Description
-
-
-|xref: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`]
-
-
-|xref: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()`]
-|`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()`]
-|`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. +
-
-It is also possible to change the default through a xref:rgcfg.adoc#__rgcfg_configuring-core_isis-viewers-propertyLayout-labelPosition[configuration property]
-
-
-|xref: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.
-
-
-|xref:rgant.adoc#_rgant-PropertyLayout_named[`named()`]
-|String
-|to override the name inferred from the collection's name in code. +
-
-A typical use case is if the desired name is a reserved Java keyword, such as `default` or `package`.
-
-
-|`namedEscaped()`
-|`true`, `false` +
-(`true`)
-|whether to HTML escape the name of this property.
-
-
-|xref: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()`]
-|Positive integer.
-|the typical entry length of a field, use to determine the optimum width for display
-
-|===
-
-
-
-
-For example:
-
-[source,java]
-----
-public class ToDoItem {
- @PropertyLayout(
- cssClass="x-key",
- named="Description of this <i>item</i>",
- namedEscaped=false,
- describedAs="What needs to be done",
- labelPosition=LabelPosition.LEFT,
- typicalLength=80
- )
- public String getDescription() { ... }
- ...
-}
-----
-
-It is also possible to apply the annotation to actions of domain services that are acting as link:../../more-advanced-topics/how-to-01-062-How-to-decouple-dependencies-using-contributions.html[contributed properties].
-
-
-
-As an alternative to using the `@PropertyLayout` annotation, a dynamic layout using xref:ugfun.adoc#_ugfun_object-layout_dynamic[`.layout.json`] file can be specified; for example:
-
-[source,javascript]
-----
-"description": {
- "propertyLayout": {
- "cssClass": "x-key",
- "describedAs": "What needs to be done",
- "labelPosition": "LEFT",
- "typicalLength": 80
- }
-}
-----
-
-
-
-
-[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
-so that boilerplate-busting tools such as link:https://projectlombok.org/[Project Lombok] can be used.
-====
-
-
-
-include::_rgant-PropertyLayout_cssClass.adoc[leveloffset=+1]
-include::_rgant-PropertyLayout_describedAs.adoc[leveloffset=+1]
-include::_rgant-PropertyLayout_labelPosition.adoc[leveloffset=+1]
-include::_rgant-PropertyLayout_multiLine.adoc[leveloffset=+1]
-include::_rgant-PropertyLayout_named.adoc[leveloffset=+1]
-include::_rgant-PropertyLayout_renderedAsDayBefore.adoc[leveloffset=+1]
-include::_rgant-PropertyLayout_typicalLength.adoc[leveloffset=+1]
-
-
-
-
-
-
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/adocs/documentation/src/main/asciidoc/guides/_rgant-PropertyLayout_cssClass.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgant-PropertyLayout_cssClass.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgant-PropertyLayout_cssClass.adoc
deleted file mode 100644
index 1ffe390..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgant-PropertyLayout_cssClass.adoc
+++ /dev/null
@@ -1,36 +0,0 @@
-[[_rgant-PropertyLayout_cssClass]]
-= `cssClass()`
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-:_basedir: ../
-:_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.
-
-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].
-
-
-For example:
-
-[source,java]
-----
-public class ToDoItem {
- @PropertyLayout(cssClass="x-key")
- public LocalDate getDueBy() { ... }
-}
-----
-
-
-
-
-As an alternative to using the annotation, the dynamic xref:ugfun.adoc#_ugfun_object-layout_dynamic[`.layout.json`]
-can be used instead, eg:
-
-[source,javascript]
-----
-"dueBy": {
- "propertyLayout": { "cssClass": "x-key" }
-}
-----
-
-
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/adocs/documentation/src/main/asciidoc/guides/_rgant-PropertyLayout_describedAs.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgant-PropertyLayout_describedAs.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgant-PropertyLayout_describedAs.adoc
deleted file mode 100644
index 401fb46..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgant-PropertyLayout_describedAs.adoc
+++ /dev/null
@@ -1,33 +0,0 @@
-[[_rgant-PropertyLayout_describedAs]]
-= `describedAs()`
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-:_basedir: ../
-:_imagesdir: images/
-
-
-
-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].
-
-For example:
-
-[source,java]
-----
-public class Customer {
- @DescribedAs("The name that the customer has indicated that they wish to be " +
- "addressed as (e.g. Johnny rather than Jonathan)")
- public String getFirstName() { ... }
-}
-----
-
-
-As an alternative to using the annotation, the dynamic xref:ugfun.adoc#_ugfun_object-layout_dynamic[`.layout.json`]
-can be used instead, eg:
-
-[source,javascript]
-----
-"firstName:" {
- "propertyLayout": {
- "describedAs": "The name that the customer has indicated that they wish to be addressed as (e.g. Johnny rather than Jonathan)"
- }
-}
-----
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/adocs/documentation/src/main/asciidoc/guides/_rgant-PropertyLayout_hidden.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgant-PropertyLayout_hidden.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgant-PropertyLayout_hidden.adoc
deleted file mode 100644
index 7743805..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgant-PropertyLayout_hidden.adoc
+++ /dev/null
@@ -1,78 +0,0 @@
-[[_rgant-PropertyLayout_hidden]]
-= `hidden()`
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-:_basedir: ../
-:_imagesdir: images/
-
-
-
-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].
-
-[TIP]
-====
-It is also possible to use xref:rgant.adoc#_rgant-PropertyLayout_hidden[`@PropertyLayout#hidden()`] or xref:ugfun.adoc#_ugfun_object-layout_dynamic[dynamic layouts] 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.
-====
-
-
-For example:
-
-[source,java]
-----
-public class Customer {
- @PropertyLayout(
- hidden=Where.ALL_TABLES
- )
- public int getInternalId() { ... }
- ...
-}
-----
-
-The acceptable values for the `where` parameter are:
-
-* `Where.EVERYWHERE` or `Where.ANYWHERE` +
-+
-The property should be hidden everywhere.
-
-* `Where.ANYWHERE` +
-+
-Synonym for everywhere.
-
-* `Where.OBJECT_FORMS` +
-+
-The property should be hidden when displayed within an object form.
-
-* `Where.PARENTED_TABLES` +
-+
-The property should be hidden when displayed as a column of a table within a parent object's collection.
-
-* `Where.STANDALONE_TABLES` +
-+
-The property should be hidden when displayed as a column of a table showing a standalone list of objects, for example as returned by a repository query.
-
-* `Where.ALL_TABLES` +
-+
-The property should be hidden when displayed as a column of a table, either an object's * collection or a standalone list. This combines `PARENTED_TABLES` and `STANDALONE_TABLES`.
-
-* `Where.NOWHERE` +
-+
-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
-tables. Annotating with `@Property(where=Where.NOWHERE)` overrides this.
-
-
-[NOTE]
-====
-The xref:ugvro.adoc#[RestfulObjects viewer] has only partial support for these `Where` enums.
-====
-
-
-As an alternative to using the annotation, the dynamic xref:ugfun.adoc#_ugfun_object-layout_dynamic[`.layout.json`]
-can be used instead, eg:
-
-[source,javascript]
-----
-"internalId": {
- "propertyLayout": { "hidden": "ALL_TABLES" }
-}
-----