You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@causeway.apache.org by ah...@apache.org on 2023/03/15 07:32:08 UTC
[causeway] branch master updated: CAUSEWAY-3376: remove ActionLayout#bookmarking from docs
This is an automated email from the ASF dual-hosted git repository.
ahuber pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/causeway.git
The following commit(s) were added to refs/heads/master by this push:
new 89aab77716 CAUSEWAY-3376: remove ActionLayout#bookmarking from docs
89aab77716 is described below
commit 89aab77716db59895a0d2a8cb3084947ee5409a4
Author: Andi Huber <ah...@apache.org>
AuthorDate: Wed Mar 15 08:32:04 2023 +0100
CAUSEWAY-3376: remove ActionLayout#bookmarking from docs
---
.../applib/pages/index/annotation/ActionLayout.adoc | 17 ++++++++++++++---
.../pages/index/layout/component/ActionLayoutData.adoc | 2 --
.../domain-entities-and-services/domain-services.adoc | 1 -
3 files changed, 14 insertions(+), 6 deletions(-)
diff --git a/antora/components/refguide-index/modules/applib/pages/index/annotation/ActionLayout.adoc b/antora/components/refguide-index/modules/applib/pages/index/annotation/ActionLayout.adoc
index 99196dd222..04e78b0474 100644
--- a/antora/components/refguide-index/modules/applib/pages/index/annotation/ActionLayout.adoc
+++ b/antora/components/refguide-index/modules/applib/pages/index/annotation/ActionLayout.adoc
@@ -10,7 +10,8 @@ Layout hints for actions.
----
@interface ActionLayout {
String associateWith() default ""; // <.>
- BookmarkPolicy bookmarking() default BookmarkPolicy.NOT_SPECIFIED; // <.>
+ @Deprecated(forRemoval = true, since = "2.0.0-RC1")
+BookmarkPolicy bookmarking() default BookmarkPolicy.NOT_SPECIFIED; // <.>
String cssClass() default ""; // <.>
String cssClassFa() default ""; // <.>
CssClassFaPosition cssClassFaPosition() default CssClassFaPosition.LEFT; // <.>
@@ -35,7 +36,12 @@ Associates this action with a property or collection, specifying its id.
<.> xref:#bookmarking[bookmarking]
+
--
-Whether (and how) this action's result can be bookmarked in the UI, overriding any _DomainObjectLayout#bookmarking()_ on the return type if present.
+[WARNING]
+====
+[red]#_deprecated:_#
+
+Conflicting semantics with _DomainObjectLayout#bookmarking()_ , that is, if present on this action's return type, hence deprecated for removal.
+====
--
<.> xref:#cssClass[cssClass]
+
@@ -121,7 +127,12 @@ Note that it is also possible to associate an action with a collection using _Ac
[#bookmarking]
=== bookmarking
-Whether (and how) this action's result can be bookmarked in the UI, overriding any _DomainObjectLayout#bookmarking()_ on the return type if present.
+[WARNING]
+====
+[red]#_deprecated:_#
+
+Conflicting semantics with _DomainObjectLayout#bookmarking()_ , that is, if present on this action's return type, hence deprecated for removal.
+====
[#cssClass]
=== cssClass
diff --git a/antora/components/refguide-index/modules/applib/pages/index/layout/component/ActionLayoutData.adoc b/antora/components/refguide-index/modules/applib/pages/index/layout/component/ActionLayoutData.adoc
index 7e8e116647..814ba58411 100644
--- a/antora/components/refguide-index/modules/applib/pages/index/layout/component/ActionLayoutData.adoc
+++ b/antora/components/refguide-index/modules/applib/pages/index/layout/component/ActionLayoutData.adoc
@@ -13,8 +13,6 @@ class ActionLayoutData {
ActionLayoutData(String id)
String getId() // <.>
void setId(String id)
- BookmarkPolicy getBookmarking()
- void setBookmarking(BookmarkPolicy bookmarking)
String getCssClass()
void setCssClass(String cssClass)
String getCssClassFa()
diff --git a/antora/components/userguide/modules/fun/pages/domain-entities-and-services/domain-services.adoc b/antora/components/userguide/modules/fun/pages/domain-entities-and-services/domain-services.adoc
index 1a013d802d..10ea62efe5 100644
--- a/antora/components/userguide/modules/fun/pages/domain-entities-and-services/domain-services.adoc
+++ b/antora/components/userguide/modules/fun/pages/domain-entities-and-services/domain-services.adoc
@@ -113,7 +113,6 @@ public class Customers {
protected final CustomerRepository customerRepository; // <.>
@Action(semantics = SemanticsOf.SAFE)
- @ActionLayout(bookmarking = BookmarkPolicy.AS_ROOT)
public List<Customer> findByName( // <.>
@ParameterLayout(named="Name") // <.>
final String name ) {