Style (enum)

Mode of operation when downloading a layout file (while prototyping).TODO update for v2 - @MemberGroupLayout and @MemberOrder have been removed

It affects the way the file’s content is assembled. Once a layout file is in place, its layout data takes precedence over any conflicting layout data from annotations.

API

Style.java
enum Style {
  CURRENT     (1)
  COMPLETE     (2)
  NORMALIZED     (3)
  MINIMAL     (4)
}
1 CURRENT

The current layout for the domain class.

2 COMPLETE

As per #NORMALIZED , but also with all (non-null) facets for all properties/collections/actions also included included in the grid.

3 NORMALIZED

Default, whereby missing properties/collections/actions are added to regions, and unused/empty regions are removed/trimmed.

4 MINIMAL

As per #NORMALIZED , but with no properties/collections/actions.

Members

CURRENT

The current layout for the domain class.

If a layout.xml exists, then the grid returned will correspond to that grid, having been org.apache.isis.applib.services.grid.GridService#normalize(Grid) normalized . If there is no layout.xml file, then the grid returned will be the org.apache.isis.applib.services.grid.GridService#defaultGridFor(Class) default grid , also org.apache.isis.applib.services.grid.GridService#normalize(Grid) normalized .

COMPLETE

As per #NORMALIZED , but also with all (non-null) facets for all properties/collections/actions also included included in the grid.

The intention here is that any layout metadata annotations can be removed from the code.

  • @MemberGroupLayout : serialized as XML

  • @MemberOrder : serialized as XML

  • @ActionLayout, @PropertyLayout, @CollectionLayout : serialized as XML

NORMALIZED

Default, whereby missing properties/collections/actions are added to regions, and unused/empty regions are removed/trimmed.

It should be possible to remove any MemberOrder annotation but any property/collection/action layout annotations would need to be retained.

  • @MemberGroupLayout : serialized as XML

  • @MemberOrder : serialized as XML

  • @ActionLayout, @PropertyLayout, @CollectionLayout : ignored

MINIMAL

As per #NORMALIZED , but with no properties/collections/actions.

The intention here is for layout annotations that "bind" the properties/collections/actions to the regions to be retained.

  • @MemberGroupLayout : serialized as XML

  • @MemberOrder : ignored

  • @ActionLayout, @PropertyLayout, @CollectionLayout : ignored