LayoutExportStyle (enum)

Format option when generating a layout file (while prototyping).

Once a layout file is in place, its layout data takes precedence over any conflicting layout data from annotations.

API

LayoutExportStyle.java
enum LayoutExportStyle {
  COMPLETE     (1)
  MINIMAL     (2)
  LayoutExportStyle defaults()
}
1 COMPLETE

Format that yields a full representation for the layout.xml , such that any layout metadata annotations could be removed from code, without affecting the resulting BSGrid , when loaded from layout.xml . The resulting BSGrid has all the metadata, broadly speaking corresponding to the DomainObjectLayout , ActionLayout , PropertyLayout and CollectionLayout .

2 MINIMAL

Format that yields a minimal representation for the layout.xml , such that layout annotations are required in code to at least 'bind' the properties/collections/actions to their regions (groups and tabs).

Members

COMPLETE

Format that yields a full representation for the layout.xml , such that any layout metadata annotations could be removed from code, without affecting the resulting BSGrid , when loaded from layout.xml . The resulting BSGrid has all the metadata, broadly speaking corresponding to the DomainObjectLayout , ActionLayout , PropertyLayout and CollectionLayout .

In other words: if a 'complete' grid is persisted as the layout.xml , then there should be no need for any of the layout annotations, to be required in the domain class itself.

MINIMAL

Format that yields a minimal representation for the layout.xml , such that layout annotations are required in code to at least 'bind' the properties/collections/actions to their regions (groups and tabs).

In other words: the layout.xml is used only to specify the positioning of the groups and tabs, but has no additional meta data. The expectation is that most of the layout annotations ( DomainObjectLayout , ActionLayout , PropertyLayout , CollectionLayout will still be retained in the domain class code.