This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a commit to branch ISIS-3197
in repository https://gitbox.apache.org/repos/asf/isis.git
The following commit(s) were added to refs/heads/ISIS-3197 by this push:
new 488e9f5943 ISIS-3197: regen docs
488e9f5943 is described below
commit 488e9f5943fca777d753dc09c0b41a11c138d356
Author: Dan Haywood <d...@haywood-associates.co.uk>
AuthorDate: Thu Sep 1 10:46:18 2022 +0100
ISIS-3197: regen docs
---
.../pages/index/annotation/CollectionLayout.adoc | 11 ++++
.../pages/index/annotation/DomainObjectLayout.adoc | 11 ++++
.../pages/index/annotation/TableDecoration.adoc | 64 ++++++++++++++++++++++
.../pages/index/services/metamodel/BeanSort.adoc | 2 +-
.../index/services/registry/ServiceRegistry.adoc | 16 +++---
.../index/metamodel/object/ManagedObject.adoc | 51 +++++++----------
core/adoc/modules/_overview/pages/about.adoc | 3 +-
7 files changed, 116 insertions(+), 42 deletions(-)
diff --git
a/antora/components/refguide-index/modules/applib/pages/index/annotation/CollectionLayout.adoc
b/antora/components/refguide-index/modules/applib/pages/index/annotation/CollectionLayout.adoc
index 26adbc472c..d1d38fb1ff 100644
---
a/antora/components/refguide-index/modules/applib/pages/index/annotation/CollectionLayout.adoc
+++
b/antora/components/refguide-index/modules/applib/pages/index/annotation/CollectionLayout.adoc
@@ -18,6 +18,7 @@ Layout hints for collections.
String sequence() default ""; // <.>
@SuppressWarnings("rawtypes")
Class<? extends Comparator> sortedBy() default Comparator.class; // <.>
+ TableDecoration tableDecoration() default TableDecoration.NOT_SPECIFIED;
// <.>
}
----
@@ -61,6 +62,11 @@ The order of this member relative to other members in the
same (layout) group, g
--
Indicates that the elements in a ( _java.util.SortedSet_ ) collection should
be sorted according to a different order than the natural sort order, as
defined by the specified _java.util.Comparator_ .
--
+<.> xref:#tableDecoration[tableDecoration]
++
+--
+Whether a parented collection when represented in a table form should
additionally be "decorated" with client-side (javascript) enhancements, for
example to enable paging and filtering.
+--
== Members
@@ -124,6 +130,11 @@ However, in some circumstances the ordering of collection
may be different to th
The purpose of this annotation is to provide a _java.util.Comparator_ such
that the collection may be sorted in an order more suitable to the context.
+[#tableDecoration]
+=== tableDecoration
+
+Whether a parented collection when represented in a table form should
additionally be "decorated" with client-side (javascript) enhancements, for
example to enable paging and filtering.
+
include::hooks/CollectionLayout_010-examples-and-usage.adoc[]
include::hooks/CollectionLayout_021-defaultView.adoc[]
diff --git
a/antora/components/refguide-index/modules/applib/pages/index/annotation/DomainObjectLayout.adoc
b/antora/components/refguide-index/modules/applib/pages/index/annotation/DomainObjectLayout.adoc
index efa74582c1..6c92fb9e92 100644
---
a/antora/components/refguide-index/modules/applib/pages/index/annotation/DomainObjectLayout.adoc
+++
b/antora/components/refguide-index/modules/applib/pages/index/annotation/DomainObjectLayout.adoc
@@ -17,6 +17,7 @@ Layout hints for domain objects.
String named() default ""; // <.>
int paged() default -1; // <.>
String plural() default ""; // <.>
+ TableDecoration tableDecoration() default TableDecoration.NOT_SPECIFIED;
// <.>
Class<? extends CssClassUiEvent<?>> cssClassUiEvent() default
CssClassUiEvent.Default.class; // <.>
Class<? extends IconUiEvent<?>> iconUiEvent() default
IconUiEvent.Default.class; // <.>
Class<? extends LayoutUiEvent<?>> layoutUiEvent() default
LayoutUiEvent.Default.class; // <.>
@@ -64,6 +65,11 @@ The page size for instances of this class when rendered
within a table.
--
The plural name of the class.
--
+<.> xref:#tableDecoration[tableDecoration]
++
+--
+Whether a standalone collection when represented in a table form should
additionally be "decorated" with client-side (javascript) enhancements, for
example to enable paging and filtering.
+--
<.> xref:#cssClassUiEvent[cssClassUiEvent]
+
--
@@ -135,6 +141,11 @@ If annotated on a type, then the page size refers to
standalone collections (eg
The plural name of the class.
+[#tableDecoration]
+=== tableDecoration
+
+Whether a standalone collection when represented in a table form should
additionally be "decorated" with client-side (javascript) enhancements, for
example to enable paging and filtering.
+
[#cssClassUiEvent]
=== cssClassUiEvent
diff --git
a/antora/components/refguide-index/modules/applib/pages/index/annotation/TableDecoration.adoc
b/antora/components/refguide-index/modules/applib/pages/index/annotation/TableDecoration.adoc
new file mode 100644
index 0000000000..9030ce6673
--- /dev/null
+++
b/antora/components/refguide-index/modules/applib/pages/index/annotation/TableDecoration.adoc
@@ -0,0 +1,64 @@
+= TableDecoration _(enum)_
+: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 ag [...]
+
+The options for defining how a parented or standalone collection when
represented in a table form should additionally be "decorated" with client-side
(javascript) enhancements.
+
+This is supported by the Wicket viewer, the principle use case being to enable
+
+== API
+
+[source,java]
+.TableDecoration.java
+----
+enum TableDecoration {
+ AS_CONFIGURED // <.>
+ NONE // <.>
+ DATATABLES_NET // <.>
+ NOT_SPECIFIED // <.>
+}
+----
+
+<.> xref:#AS_CONFIGURED[AS_CONFIGURED]
++
+--
+The collection's table representation should be decorated, if at all, as
configured in `application.properties` .
+--
+<.> xref:#NONE[NONE]
++
+--
+If this option declares that the collection's table representation should not
be decorated.
+--
+<.> xref:#DATATABLES_NET[DATATABLES_NET]
++
+--
+If this option declares that the collection's table representation be
decorated using
+--
+<.> xref:#NOT_SPECIFIED[NOT_SPECIFIED]
++
+--
+Ignore the value provided by this annotation (meaning that the framework will
keep searching, in meta annotations or superclasses/interfaces).
+--
+
+== Members
+
+[#AS_CONFIGURED]
+=== AS_CONFIGURED
+
+The collection's table representation should be decorated, if at all, as
configured in `application.properties` .
+
+If there is no configuration, then default to use _TableDecoration#NONE no_
decoration.
+
+[#NONE]
+=== NONE
+
+If this option declares that the collection's table representation should not
be decorated.
+
+[#DATATABLES_NET]
+=== DATATABLES_NET
+
+If this option declares that the collection's table representation be
decorated using
+
+[#NOT_SPECIFIED]
+=== NOT_SPECIFIED
+
+Ignore the value provided by this annotation (meaning that the framework will
keep searching, in meta annotations or superclasses/interfaces).
diff --git
a/antora/components/refguide-index/modules/applib/pages/index/services/metamodel/BeanSort.adoc
b/antora/components/refguide-index/modules/applib/pages/index/services/metamodel/BeanSort.adoc
index 847d27328c..29a12c4dd9 100644
---
a/antora/components/refguide-index/modules/applib/pages/index/services/metamodel/BeanSort.adoc
+++
b/antora/components/refguide-index/modules/applib/pages/index/services/metamodel/BeanSort.adoc
@@ -21,7 +21,7 @@ enum BeanSort {
UNKNOWN
boolean isManagedBeanContributing()
boolean isManagedBeanNotContributing()
- boolean isManagedBean()
+ boolean isManagedBeanAny()
boolean isMixin()
boolean isViewModel()
boolean isValue()
diff --git
a/antora/components/refguide-index/modules/applib/pages/index/services/registry/ServiceRegistry.adoc
b/antora/components/refguide-index/modules/applib/pages/index/services/registry/ServiceRegistry.adoc
index 98b4408133..6b7f74440d 100644
---
a/antora/components/refguide-index/modules/applib/pages/index/services/registry/ServiceRegistry.adoc
+++
b/antora/components/refguide-index/modules/applib/pages/index/services/registry/ServiceRegistry.adoc
@@ -13,8 +13,8 @@ interface ServiceRegistry {
Can<T> select(Class<T> type) // <.>
Stream<_ManagedBeanAdapter> streamRegisteredBeansOfType(Class<?>
requiredType) // <.>
Stream<_ManagedBeanAdapter> streamRegisteredBeans() // <.>
- Optional<_ManagedBeanAdapter> lookupRegisteredBeanById(String id) // <.>
- _ManagedBeanAdapter lookupRegisteredBeanByIdElseFail(String id) // <.>
+ Optional<_ManagedBeanAdapter> lookupRegisteredBeanById(LogicalType id)
// <.>
+ _ManagedBeanAdapter lookupRegisteredBeanByIdElseFail(LogicalType id) //
<.>
Optional<?> lookupBeanById(String id)
Optional<T> lookupService(Class<T> serviceClass) // <.>
Optional<T> lookupService(Class<T> serviceClass, Comparator<Object>
comparator) // <.>
@@ -43,12 +43,12 @@ Streams all registered bean adapters implementing the
requested type.
--
Returns all bean adapters that have been registered.
--
-<.> xref:#lookupRegisteredBeanById_String[lookupRegisteredBeanById(String)]
+<.>
xref:#lookupRegisteredBeanById_LogicalType[lookupRegisteredBeanById(LogicalType)]
+
--
Returns a registered bean of given _name_ .
--
-<.>
xref:#lookupRegisteredBeanByIdElseFail_String[lookupRegisteredBeanByIdElseFail(String)]
+<.>
xref:#lookupRegisteredBeanByIdElseFail_LogicalType[lookupRegisteredBeanByIdElseFail(LogicalType)]
+
--
Returns a registered bean of given _name_ , or throws when no such bean.
@@ -96,13 +96,13 @@ Streams all registered bean adapters implementing the
requested type.
Returns all bean adapters that have been registered.
-[#lookupRegisteredBeanById_String]
-=== lookupRegisteredBeanById(String)
+[#lookupRegisteredBeanById_LogicalType]
+=== lookupRegisteredBeanById(LogicalType)
Returns a registered bean of given _name_ .
-[#lookupRegisteredBeanByIdElseFail_String]
-=== lookupRegisteredBeanByIdElseFail(String)
+[#lookupRegisteredBeanByIdElseFail_LogicalType]
+=== lookupRegisteredBeanByIdElseFail(LogicalType)
Returns a registered bean of given _name_ , or throws when no such bean.
diff --git
a/antora/components/refguide-index/modules/core/pages/index/metamodel/object/ManagedObject.adoc
b/antora/components/refguide-index/modules/core/pages/index/metamodel/object/ManagedObject.adoc
index aa69dbcb8c..675441deb9 100644
---
a/antora/components/refguide-index/modules/core/pages/index/metamodel/object/ManagedObject.adoc
+++
b/antora/components/refguide-index/modules/core/pages/index/metamodel/object/ManagedObject.adoc
@@ -10,30 +10,27 @@ Represents an instance of some element of the meta-model
managed by the framewor
----
interface ManagedObject {
Specialization getSpecialization() // <.>
+ BookmarkPolicy getBookmarkPolicy()
ObjectSpecification getSpecification() // <.>
Object getPojo() // <.>
- Optional<Bookmark> getBookmark() // <.>
- Optional<Bookmark> getBookmarkRefreshed() // <.>
void refreshViewmodel(Supplier<Bookmark> bookmarkSupplier) // <.>
- boolean isBookmarkMemoized()
Supplier<ManagedObject> asSupplier()
T assertCompliance(T pojo) // <.>
- String
titleString(UnaryOperator<TitleRenderRequest.TitleRenderRequestBuilder>
onBuilder)
- String titleString()
+ String getTitle() // <.>
Optional<ObjectSpecification> getElementSpecification() // <.>
- String getTitle()
String getIconName() // <.>
ObjectIcon getIcon()
ManagedObject unspecified() // <.>
ManagedObject empty(ObjectSpecification spec) // <.>
ManagedObject value(ObjectSpecification spec, Object pojo) // <.>
ManagedObject service(ObjectSpecification spec, Object pojo) // <.>
- ManagedObject viewmodel(ObjectSpecification spec, Object pojo) // <.>
+ ManagedObject viewmodel(ObjectSpecification spec, Object pojo,
Optional<Bookmark> bookmarkIfKnown) // <.>
ManagedObject entity(ObjectSpecification spec, Object pojo) // <.>
ManagedObject mixin(ObjectSpecification spec, Object pojo) // <.>
ManagedObject other(ObjectSpecification spec, Object pojo) // <.>
PackedManagedObject packed(ObjectSpecification elementSpec,
Can<ManagedObject> nonScalar) // <.>
ManagedObject wrapScalar(SpecificationLoader specLoader, Object pojo) //
<.>
+ ManagedObject wrapScalarInternal(ObjectSpecification spec, Object pojo,
Optional<Bookmark> bookmarkIfAny)
ManagedObject notBookmarked(ObjectSpecification spec, Object pojo)
ManagedObject of(ObjectSpecification spec, Object pojo) // <.>
ManagedObject bookmarked(ObjectSpecification spec, Object pojo, Bookmark
bookmark) // <.>
@@ -55,16 +52,6 @@ Returns the specification that details the structure
(meta-model) of this object
--
Returns the adapted domain object, the 'plain old java' object this managed
object represents with the framework.
--
-<.> xref:#getBookmark_[getBookmark()]
-+
---
-Returns the object's bookmark as identified by the ObjectManager. Bookmarks
are considered immutable, hence will be memoized once fetched.
---
-<.> xref:#getBookmarkRefreshed_[getBookmarkRefreshed()]
-+
---
-Similar to _#getBookmark()_ , but invalidates any memoized
xref:refguide:applib:index/services/bookmark/Bookmark.adoc[Bookmark] such that
the xref:refguide:applib:index/services/bookmark/Bookmark.adoc[Bookmark]
returned is recreated, reflecting the object's current state.
---
<.> xref:#refreshViewmodel_Supplier[refreshViewmodel(Supplier)]
+
--
@@ -75,10 +62,15 @@ If the underlying domain object is a viewmodel, refreshes
any referenced entitie
--
Unary operator asserting that _pojo_ and _#getSpecification()_ are compliant
with the policies from _#getSpecialization()_ .
--
+<.> xref:#getTitle_[getTitle()]
++
+--
+The (untranslated) title of the wrapped pojo.
+--
<.> xref:#getElementSpecification_[getElementSpecification()]
+
--
-Used only for (standalone or parented) collections.
+As used for the element type of collections.
--
<.> xref:#getIconName_[getIconName()]
+
@@ -105,7 +97,7 @@ VALUE
--
SERVICE
--
-<.> xref:#viewmodel_ObjectSpecification_Object[viewmodel(ObjectSpecification,
Object)]
+<.>
xref:#viewmodel_ObjectSpecification_Object_Optional[viewmodel(ObjectSpecification,
Object, Optional)]
+
--
VIEWMODEL
@@ -163,16 +155,6 @@ Returns the specification that details the structure
(meta-model) of this object
Returns the adapted domain object, the 'plain old java' object this managed
object represents with the framework.
-[#getBookmark_]
-=== getBookmark()
-
-Returns the object's bookmark as identified by the ObjectManager. Bookmarks
are considered immutable, hence will be memoized once fetched.
-
-[#getBookmarkRefreshed_]
-=== getBookmarkRefreshed()
-
-Similar to _#getBookmark()_ , but invalidates any memoized
xref:refguide:applib:index/services/bookmark/Bookmark.adoc[Bookmark] such that
the xref:refguide:applib:index/services/bookmark/Bookmark.adoc[Bookmark]
returned is recreated, reflecting the object's current state.
-
[#refreshViewmodel_Supplier]
=== refreshViewmodel(Supplier)
@@ -183,10 +165,15 @@ If the underlying domain object is a viewmodel, refreshes
any referenced entitie
Unary operator asserting that _pojo_ and _#getSpecification()_ are compliant
with the policies from _#getSpecialization()_ .
+[#getTitle_]
+=== getTitle()
+
+The (untranslated) title of the wrapped pojo.
+
[#getElementSpecification_]
=== getElementSpecification()
-Used only for (standalone or parented) collections.
+As used for the element type of collections.
[#getIconName_]
=== getIconName()
@@ -215,8 +202,8 @@ VALUE
SERVICE
-[#viewmodel_ObjectSpecification_Object]
-=== viewmodel(ObjectSpecification, Object)
+[#viewmodel_ObjectSpecification_Object_Optional]
+=== viewmodel(ObjectSpecification, Object, Optional)
VIEWMODEL
diff --git a/core/adoc/modules/_overview/pages/about.adoc
b/core/adoc/modules/_overview/pages/about.adoc
index 6aaa2bb073..7786eaf074 100644
--- a/core/adoc/modules/_overview/pages/about.adoc
+++ b/core/adoc/modules/_overview/pages/about.adoc
@@ -1237,7 +1237,7 @@ org.jmock:jmock:jar:<managed> +
.Document Index Entries
****
-xref:refguide:applib:index/Identifier.adoc[Identifier],
xref:refguide:applib:index/IsisModuleApplib.adoc[IsisModuleApplib],
xref:refguide:applib:index/IsisModuleApplibChangeAndExecutionLoggers.adoc[IsisModuleApplibChangeAndExecutionLoggers],
xref:refguide:applib:index/IsisModuleApplibMixins.adoc[IsisModuleApplibMixins],
xref:refguide:applib:index/ViewModel.adoc[ViewModel],
xref:refguide:applib:index/annotation/Action.adoc[Action],
xref:refguide:applib:index/annotation/ActionLayout.adoc[A [...]
+xref:refguide:applib:index/Identifier.adoc[Identifier],
xref:refguide:applib:index/IsisModuleApplib.adoc[IsisModuleApplib],
xref:refguide:applib:index/IsisModuleApplibChangeAndExecutionLoggers.adoc[IsisModuleApplibChangeAndExecutionLoggers],
xref:refguide:applib:index/IsisModuleApplibMixins.adoc[IsisModuleApplibMixins],
xref:refguide:applib:index/ViewModel.adoc[ViewModel],
xref:refguide:applib:index/annotation/Action.adoc[Action],
xref:refguide:applib:index/annotation/ActionLayout.adoc[A [...]
****
|Apache Isis Core - Code Gen (ByteBuddy)
@@ -2958,6 +2958,7 @@ org.apache.wicket:wicket-spring:jar:<managed> +
org.datanucleus:javax.jdo:jar:<managed> +
org.ow2.asm:asm-util:jar:<managed> +
org.slf4j:slf4j-api:jar:<managed> +
+org.webjars:datatables:jar:<managed> +
org.webjars:jquery:jar:<managed> +
org.webjars:jquery-ui:jar:<managed> +
org.webjars:select2:jar:<managed> +
