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/10/01 06:45:31 UTC
[causeway] 01/01: CAUSEWAY-3575: site doc: replace references to 'Bootstrap 3' with just 'Bootstrap'
This is an automated email from the ASF dual-hosted git repository.
ahuber pushed a commit to branch 3575-layout.slotin.order
in repository https://gitbox.apache.org/repos/asf/causeway.git
commit a15c591be491201e2374598cc97dc669421d1af8
Author: andi-huber <ah...@apache.org>
AuthorDate: Sun Oct 1 08:45:24 2023 +0200
CAUSEWAY-3575: site doc: replace references to 'Bootstrap 3' with just
'Bootstrap'
---
.../index/services/grid/GridSystemService.adoc | 2 +-
.../applib-classes/partials/layout/menubars.adoc | 16 +++++------
.../partials/layout/object-layout.adoc | 32 +++++++++++-----------
.../modules/applib-svc/partials/_metadata-spi.adoc | 2 +-
.../ui-layout-and-hints/object-layout.adoc | 4 +--
.../applib/services/grid/GridSystemService.java | 4 +--
...tationFacetFactoryTest_executionPublishing.java | 1 -
7 files changed, 30 insertions(+), 31 deletions(-)
diff --git a/antora/components/refguide-index/modules/applib/pages/index/services/grid/GridSystemService.adoc b/antora/components/refguide-index/modules/applib/pages/index/services/grid/GridSystemService.adoc
index c7265187bd..75b2a4703d 100644
--- a/antora/components/refguide-index/modules/applib/pages/index/services/grid/GridSystemService.adoc
+++ b/antora/components/refguide-index/modules/applib/pages/index/services/grid/GridSystemService.adoc
@@ -78,7 +78,7 @@ This is used when generating the XML. The Bootstrap3 grid system provided by the
The schema location for the XSD.
-Every grid system is expected to provide a schema XSD in order to provide code completion in an IDE. The Bootstrap3 grid system provided by the framework returns the value `https://causeway.apache.org/applib/layout/grid/bootstrap3/bootstrap3.xsd`.
+Every grid system is expected to provide a schema XSD in order to provide code completion in an IDE. The Bootstrap grid system provided by the framework returns the value `https://causeway.apache.org/applib/layout/grid/bootstrap3/bootstrap3.xsd`.
[#defaultGrid_Class]
=== defaultGrid(Class)
diff --git a/antora/components/refguide/modules/applib-classes/partials/layout/menubars.adoc b/antora/components/refguide/modules/applib-classes/partials/layout/menubars.adoc
index 439bf5bcfb..efb1d772c2 100644
--- a/antora/components/refguide/modules/applib-classes/partials/layout/menubars.adoc
+++ b/antora/components/refguide/modules/applib-classes/partials/layout/menubars.adoc
@@ -27,24 +27,24 @@ This design greatly assists in the implementation of generic REST clients.
The menu classes reside in the `org.apache.causeway.applib.layout.menubars.bootstrap3` package, consisting of:
-* `BS3MenuBars`
+* `BSMenuBars`
+
-The top-level structure that define three fields: a primary `BS3MenuBar`, secondary `BS3MenuBar` and tertiary `BS3MenuBar`.
-The xref:vw:ROOT:about.adoc[Web UI (Wicket viewer)] places the primary bar to the left, the secondary bar aligned right, and the tertiary bar (expected to consist of just one `BS3Menu`) under the user names.
+The top-level structure that define three fields: a primary `BSMenuBar`, secondary `BSMenuBar` and tertiary `BSMenuBar`.
+The xref:vw:ROOT:about.adoc[Web UI (Wicket viewer)] places the primary bar to the left, the secondary bar aligned right, and the tertiary bar (expected to consist of just one `BSMenu`) under the user names.
-* `BS3MenuBar`
+* `BSMenuBar`
+
-consisting of one or many ``BS3Menu``s.
+consisting of one or many ``BSMenu``s.
-* `BS3Menu`
+* `BSMenu`
+
-consisting of one or many ``BS3MenuSection``s.
+consisting of one or many ``BSMenuSection``s.
The xref:vw:ROOT:about.adoc[Web UI (Wicket viewer)] renders a separator between each section.
-* `BS3MenuSection`
+* `BSMenuSection`
+
consisting of one or many actions (``ServiceActionLayoutData``s)
diff --git a/antora/components/refguide/modules/applib-classes/partials/layout/object-layout.adoc b/antora/components/refguide/modules/applib-classes/partials/layout/object-layout.adoc
index a1eb003bcf..368edd87c9 100644
--- a/antora/components/refguide/modules/applib-classes/partials/layout/object-layout.adoc
+++ b/antora/components/refguide/modules/applib-classes/partials/layout/object-layout.adoc
@@ -13,7 +13,7 @@ These classes fall into two main categories:
* common component classes, that capture the layout metadata for an object's properties, collections and actions.
These are bound (or associated) to the regions of the grid
-The framework provides an implementation of the grid classes modelled closely on link:http://getbootstrap.com[Bootstrap 3], along with xref:vw:ROOT:about.adoc[Web UI (Wicket viewer)] components capable of rendering that grid system.
+The framework provides an implementation of the grid classes modelled closely on link:http://getbootstrap.com[Bootstrap], along with xref:vw:ROOT:about.adoc[Web UI (Wicket viewer)] components capable of rendering that grid system.
In principle it is also possible to extend the layout architecture for other grid systems.
The component classes, though, are intended to be reusable across all grid systems.
@@ -35,7 +35,7 @@ The component classes reside in the `org.apache.causeway.applib.layout.component
* `FieldSet` +
+
-A fieldset (sometimes also called a property group or member group) of a number of the domain object's properties (along with any associationed actions of those properties).
+A fieldset (sometimes also called a property group or member group) of a number of the domain object's properties (along with any associated actions of those properties).
* layout data classes, which correspond to the similarly named annotations:
@@ -54,9 +54,9 @@ The `GridAbstract` convenience superclass provides a partial implementation of t
The XSD for these classes is available at link:https://causeway.apache.org/applib/layout/component/component.xsd[].
-== Bootstrap3 Grid
+== Bootstrap Grid
-The bootstrap3 grid classes are modelled closely on link:http://getbootstrap.com[Bootstrap 3].
+The bootstrap grid classes are modelled closely on link:http://getbootstrap.com[Bootstrap].
Bootstrap's link:http://getbootstrap.com/css/#grid[grid system] divides the page width equally into 12 columns, and so each column spans 1 or more of these widths.
Thus, a column with a span of 12 is the full width, one with a span of 6 is half the width, one with a span of 4 is a third of the width, and so on.
@@ -67,42 +67,42 @@ It is also possible to specify multiple size/spans for a given column.
The grid classes provided by Apache Causeway reside in the `org.apache.causeway.applib.layout.grid.bootstrap3` package, and consist of:
-* `BS3Grid` +
+* `BSGrid` +
+
-Consists of a number of ``BS3Row``s.
+Consists of a number of ``BSRow``s.
+
This class is the concrete implementation of `Grid` interface, discussed previously.
As such, it extends the `Grid.Visitor` to iterate over all of the ``Row``s of the grid.
-* `BS3Row` +
+* `BSRow` +
+
-A container of ``BS3Col``s.
+A container of ``BSCol``s.
This element is rendered as `<div class="row">`.
-* `BS3Col` +
+* `BSCol` +
+
A container of almost everything else.
A column most commonly contains properties (grouped into ``FieldSet``s, described above) or collections (specified by ``CollectionLayoutData``, also above).
-However, a `Col` might instead contain a ``BS3TabGroup`` (described below) in order that the object members is arranged into tabs.
+However, a `Col` might instead contain a ``BSTabGroup`` (described below) in order that the object members is arranged into tabs.
+
It is also possible for a ``Col`` to contain the object's title/icon (using ``DomainObjectLayoutData``) or indeed arbitrary actions (using ``ActionLayoutData`).
+
-Finally, a ``BS3Col`` can also contain other ``BS3Row``s, allowing arbitrarily deep hierarchies of containers as required.
+Finally, a ``BSCol`` can also contain other ``BSRow``s, allowing arbitrarily deep hierarchies of containers as required.
+
This element is rendered as, for example, `<div class="col-md-4">` (for a size `MD`, span of 4).
-* `BS3TabGroup` +
+* `BSTabGroup` +
+
-A container of ``BS3Tab``s.
+A container of ``BSTab``s.
-* `BS3Tab` +
+* `BSTab` +
+
-A container of ``BS3Row``s, which will in turn contain ``BS3Col``s and thence ultimately the object's members.
+A container of ``BSRow``s, which will in turn contain ``BSCol``s and thence ultimately the object's members.
There are also two close cousins of `Col`, namely `ClearFixVisible` and `ClearFixHidden`.
These map to Bootstrap's link:http://getbootstrap.com/css/#responsive-utilities[responsive utility class]es, and provide greater control for responsive designs.
-As you can probably guess, the `BS3Grid` is the top-level object (that is, it is JAXB `@XmlRootElement`); this is the object that is serialized to/from XML.
+As you can probably guess, the `BSGrid` is the top-level object (that is, it is JAXB `@XmlRootElement`); this is the object that is serialized to/from XML.
All of these classes also allow custom CSS to be specified; these are added to the CSS classes for the corresponding `<div`> in the rendered page.
The xref:vw:ROOT:customisation.adoc#custom-css[application.css] file can then be used for application-specific CSS, allowing arbitrary fine-tuning of the layout of the page.
diff --git a/antora/components/refguide/modules/applib-svc/partials/_metadata-spi.adoc b/antora/components/refguide/modules/applib-svc/partials/_metadata-spi.adoc
index 7cb79300cc..a9f3aa2953 100644
--- a/antora/components/refguide/modules/applib-svc/partials/_metadata-spi.adoc
+++ b/antora/components/refguide/modules/applib-svc/partials/_metadata-spi.adoc
@@ -28,7 +28,7 @@ xref:refguide:applib:index/services/grid/GridSystemService.adoc[GridSystemServic
|xref:refguide:applib:index/services/grid/GridSystemService.adoc[GridSystemService]
-|Validates and normalizes the grid layout for a domain class (with respect to a particular grid system such as Bootstrap3), also providing a default grid (for those domain classes where there is no grid layout).
+|Validates and normalizes the grid layout for a domain class (with respect to a particular grid system such as Bootstrap), also providing a default grid (for those domain classes where there is no grid layout).
diff --git a/antora/components/userguide/modules/ROOT/partials/ui-layout-and-hints/object-layout.adoc b/antora/components/userguide/modules/ROOT/partials/ui-layout-and-hints/object-layout.adoc
index 62d3be03d8..17e1d74384 100644
--- a/antora/components/userguide/modules/ROOT/partials/ui-layout-and-hints/object-layout.adoc
+++ b/antora/components/userguide/modules/ROOT/partials/ui-layout-and-hints/object-layout.adoc
@@ -33,12 +33,12 @@ The layout file distinguishes between two types of element:
* those that define a grid structure, of: rows, columns, tab groups and tabs.
+
-The rows and columns are closely modelled on link:http://getbootstrap.com[Bootstrap 3] (used in the implementation of the xref:vw:ROOT:about.adoc[Web UI (Wicket viewer)]).
+The rows and columns are closely modelled on link:http://getbootstrap.com[Bootstrap] (used in the implementation of the xref:vw:ROOT:about.adoc[Web UI (Wicket viewer)]).
* those that define common components, of: fieldsets (previously called member groups or property groups), properties, collections, actions and also the title/icon of the domain object itself.
More information about these classes can be found in xref:refguide:applib-classes:layout.adoc#object-layout[the reference guide].
-More information on Bootstrap 3's grid system can be found link:http://getbootstrap.com/css/#grid[here].
+More information on Bootstrap's grid system can be found link:http://getbootstrap.com/css/#grid[here].
== By Example
diff --git a/api/applib/src/main/java/org/apache/causeway/applib/services/grid/GridSystemService.java b/api/applib/src/main/java/org/apache/causeway/applib/services/grid/GridSystemService.java
index 1371dbea28..1b73e0db50 100644
--- a/api/applib/src/main/java/org/apache/causeway/applib/services/grid/GridSystemService.java
+++ b/api/applib/src/main/java/org/apache/causeway/applib/services/grid/GridSystemService.java
@@ -49,7 +49,7 @@ public interface GridSystemService<G extends Grid> {
* The target namespace for this grid system.
*
* <p>
- * This is used when generating the XML. The Bootstrap3 grid system
+ * This is used when generating the XML. The Bootstrap grid system
* provided by the framework returns the value
* `https://causeway.apache.org/applib/layout/grid/bootstrap3`.
* </p>
@@ -61,7 +61,7 @@ public interface GridSystemService<G extends Grid> {
*
* <p>
* Every grid system is expected to provide a schema XSD in order to
- * provide code completion in an IDE. The Bootstrap3 grid system
+ * provide code completion in an IDE. The Bootstrap grid system
* provided by the framework returns the value
* `https://causeway.apache.org/applib/layout/grid/bootstrap3/bootstrap3.xsd`.
* </p>
diff --git a/core/metamodel/src/test/java/org/apache/causeway/core/metamodel/facets/actions/action/ActionAnnotationFacetFactoryTest_executionPublishing.java b/core/metamodel/src/test/java/org/apache/causeway/core/metamodel/facets/actions/action/ActionAnnotationFacetFactoryTest_executionPublishing.java
index f5e98c5ece..23c1d390fb 100644
--- a/core/metamodel/src/test/java/org/apache/causeway/core/metamodel/facets/actions/action/ActionAnnotationFacetFactoryTest_executionPublishing.java
+++ b/core/metamodel/src/test/java/org/apache/causeway/core/metamodel/facets/actions/action/ActionAnnotationFacetFactoryTest_executionPublishing.java
@@ -23,7 +23,6 @@ import org.junit.jupiter.api.Test;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertNull;
-import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assertions.assertTrue;
import org.apache.causeway.applib.annotation.Action;