Applib

Default configuration for applib annotations.

Property Default Description

causeway.applib.annotation.
action-layout.css-class-fa.
patterns

[all.:fa-solid fa-list, list.
*:fa-solid fa-list, find.
*:fa-search, lookup.
*:fa-search, search.
*:fa-search, send.
*:fa-regular fa-paper-plane, open.
*:fa-solid fa-arrow-up-right-from-
square, close.
*:fa-solid fa-regular fa-rectangle-
xmark, recent.
*:fa-solid fa-clock-rotate-
left, lock.
*:fa-solid fa-lock, unlock.
*:fa-solid fa-unlock, permit.
*:fa-solid fa-unlock, review.
*:fa-solid fa-eye, add.
*:fa-regular fa-square-plus, plus.
*:fa-regular fa-square-
plus, remove.
*:fa-regular fa-square-
minus, minus.
*:fa-regular fa-square-minus, sign.
*:fa-solid fa-signature, clear.
*:fa-solid fa-broom, create.
*:fa-regular fa-square-plus, new.
*:fa-regular fa-square-
plus, delete.
*:fa-solid fa-trash, change.
*:fa-regular fa-pen-to-
square, edit.
*:fa-regular fa-pen-to-
square, maintain.
*:fa-regular fa-pen-to-
square, update.
*:fa-regular fa-pen-to-square, cut.
*:fa-solid fa-scissors, move.
*:fa-solid fa-angles-right, copy.
*:fa-regular fa-copy, duplicate.
*:fa-solid fa-clone, clone.
*:fa-solid fa-clone, categorise.
*:fa-regular fa-folder-
open, download.
*:fa-solid fa-download, upload.
*:fa-solid fa-upload, execute.
*:fa-solid fa-bolt, run.
*:fa-solid fa-bolt, trigger.
*:fa-solid fa-bolt, link.
*:fa-solid fa-link, unlink.
*:fa-solid fa-link-slash, start.
*:fa-solid fa-play, play.
*:fa-solid fa-play, resume.
*:fa-solid fa-play, pause.
*:fa-solid fa-pause, suspend.
*:fa-solid fa-pause, stop.
*:fa-solid fa-stop, terminate.
*:fa-solid fa-stop, previous.
*:fa-backward-step, next.
*:fa-forward-step, approve.
*:fa-regular fa-thumbs-up, reject.
*:fa-regular fa-thumbs-
down, verify.
*:fa-solid fa-check, decline.
*:fa-solid fa-xmark, cancel.
*:fa-solid fa-xmark, discard.
*:fa-regular fa-trash-can, assign.
*:fa-regular fa-hand-point-
right, calculate.
*:fa-calculator, import.
*:fa-solid fa-file-import, export.
*:fa-solid fa-file-export, first.
*:fa-regular fa-star, install.
*:fa-solid fa-wrench, setup.
*:fa-solid fa-gear, configure.
*:fa-solid fa-gear, refresh.
*:fa-sync, renew.
*:fa-rotate-right, reset.
*:fa-rotate-left, save.
*:fa-regular fa-floppy-
disk, switch.:fa-exchange, random.
*:fa-shuffle, view.
*:fa-regular fa-eye, wizard.
*:fa-solid fa-wand-magic-sparkles]

null

causeway.applib.annotation.
action-layout.css-class.patterns

[add.:btn-info, remove.
*:btn-warning, start.
*:btn-info, play.:btn-info, stop.
:btn-warning, reset.
*:btn-warning, new.
*:btn-info, create.
*:btn-info, delete.
*:btn-danger, verify.
*:btn-success, decline.
*:btn-danger, save.
*:btn-success, approve.
*:btn-success, reject.:btn-danger]

null

causeway.applib.annotation.action.
command-publishing

NONE

null

causeway.applib.annotation.action.
domain-event.post-for-default

true

null

causeway.applib.annotation.action.
execution-publishing

NONE

null

causeway.applib.annotation.
collection-layout.default-view

TABLE

null

causeway.applib.annotation.
collection-layout.paged

12

null

causeway.applib.annotation.
collection-layout.
sequence-policy-if-unreferenced

AS_PER_SEQUENCE

null

causeway.applib.annotation.
collection-layout.table-decorator

org.apache.causeway.applib.
annotation.TableDecorator.Default

null

causeway.applib.annotation.
collection.domain-event.
post-for-default

true

null

causeway.applib.annotation.
domain-object-layout.
css-class-ui-event.
post-for-default

null

causeway.applib.annotation.
domain-object-layout.icon-ui-event.
post-for-default

null

causeway.applib.annotation.
domain-object-layout.
layout-ui-event.post-for-default

null

causeway.applib.annotation.
domain-object-layout.paged

25

null

causeway.applib.annotation.
domain-object-layout.
table-decorator

org.apache.causeway.applib.
annotation.TableDecorator.Default

null

causeway.applib.annotation.
domain-object-layout.
title-ui-event.post-for-default

null

causeway.applib.annotation.
domain-object.
created-lifecycle-event.
post-for-default

true

null

causeway.applib.annotation.
domain-object.editing

FALSE

null

causeway.applib.annotation.
domain-object.
entity-change-publishing

NONE

null

causeway.applib.annotation.
domain-object.
loaded-lifecycle-event.
post-for-default

true

null

causeway.applib.annotation.
domain-object.
persisted-lifecycle-event.
post-for-default

true

null

causeway.applib.annotation.
domain-object.
persisting-lifecycle-event.
post-for-default

true

null

causeway.applib.annotation.
domain-object.
removing-lifecycle-event.
post-for-default

true

null

causeway.applib.annotation.
domain-object.
updated-lifecycle-event.
post-for-default

true

null

causeway.applib.annotation.
domain-object.
updating-lifecycle-event.
post-for-default

true

null

causeway.applib.annotation.
parameter.
preceding-parameters-policy

RESET

null

causeway.applib.annotation.
property-layout.
sequence-policy-if-unreferenced

AS_PER_SEQUENCE

null

causeway.applib.annotation.
property.command-publishing

NONE

null

causeway.applib.annotation.
property.domain-event.
post-for-default

true

null

causeway.applib.annotation.
property.execution-publishing

NONE

null

causeway.applib.annotation.
view-model-layout.
css-class-ui-event.
post-for-default

true

null

causeway.applib.annotation.
view-model-layout.icon-ui-event.
post-for-default

true

null

causeway.applib.annotation.
view-model-layout.layout-ui-event.
post-for-default

true

null

causeway.applib.annotation.
view-model-layout.title-ui-event.
post-for-default

true

null

causeway.applib.annotation.
view-model.validation.
semantic-checking.enable

null

causeway.applib.service.
metrics-service.level

COUNTERS_ONLY

null

causeway.applib.annotation.
parameter-layout.label-position

NOT_SPECIFIED

null

causeway.applib.annotation.
property-layout.label-position

NOT_SPECIFIED

null

Events

Note:

  • In order for the lifecycle events to fire (persisting, loaded etc) the class must be annotated using @DomainObject (even if no attributes on that annotation are set).

  • Similarly, for UI events to fire (title, icon etc) the class must be annotated using @DomainObjectLayout (even if no attributes on that annotation are set).

  • Similarly, for domain events to fire (title, icon etc) the action/property/collection must be annotated using the appropriate @XxxLayout (even if no attributes on that annotation are set).

Non-editable Objects

The causeway.applib.annotation.domain-object.editing configuration property determines whether properties can be edited or not. By default it is disabled:

causeway.applib.annotation.domain-object.editing=false

We recommend leaving this at its default, and only selectively enabling property editing where there are likely to be no business rules, such as "notes" or "comments" properties. Doing so will help drive out the underlying business operations (processes and procedures) that require objects to change; these can then be captured as actions.