Google Git
Sign in
apache/causeway-site/4f5cd76fee90f6ecec59be43f82bc2ea41e2a953/./content/refguide/2.0.0-M3/applib-ant/ActionLayout.html
blob: df94aaaf2de1fcf50909ea1bcbe7c6a1ae074a29 [file]
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>@ActionLayout :: Apache Isis</title>
<link rel="canonical" href="https://isis.apache.org/refguide/latest/applib-ant/ActionLayout.html">
<meta name="generator" content="Antora 2.2.0">
<link rel="stylesheet" href="../../../_/css/site.css">
<link rel="stylesheet" href="../../../_/css/site-custom.css">
<link href="https://fonts.googleapis.com/css?family=Open+Sans:300,300i,400,400i,700,700i|Raleway:300,400,500,700,800|Montserrat:300,400,700" rel="stylesheet">
<link rel="home" href="https://isis.apache.org" title="Apache Isis">
</head>
<body class="article">
<header class="header">
<nav class="navbar">
<div class="navbar-brand">
<a class="navbar-item" href="https://isis.apache.org">
<span class="icon">
<img src="../../../_/img/isis-logo-48x48.png"></img>
</span>
<span>Apache Isis</span>
</a>
<button class="navbar-burger" data-target="topbar-nav">
<span></span>
<span></span>
<span></span>
</button>
</div>
<div id="topbar-nav" class="navbar-menu">
<a class="navbar-end">
<div class="navbar-item has-dropdown is-hoverable">
<a class="navbar-link" href="#">Quick Start</a>
<div class="navbar-dropdown">
<span class="navbar-item navbar-heading">Starter Apps</span>
<a class="navbar-item" href="../../../docs/latest/starters/helloworld.html">Hello World</a>
<a class="navbar-item" href="../../../docs/latest/starters/simpleapp.html">Simple App</a>
<hr class="navbar-divider"/>
<span class="navbar-item navbar-heading">Demos &amp; Tutorials</span>
<a class="navbar-item" href="../../../docs/latest/demo/about.html">Demo App</a>
<a class="navbar-item" href="https://danhaywood.gitlab.io/isis-petclinic-tutorial-docs/petclinic/1.16.2/intro.html">Petclinic (tutorial)</a>
<hr class="navbar-divider"/>
<span class="navbar-item navbar-heading">Resources</span>
<a class="navbar-item" href="../../../docs/latest/resources/cheatsheet.html">Cheatsheet</a>
<a class="navbar-item" href="../../../docs/latest/resources/icons.html">Icons</a>
</div>
</div>
<div class="navbar-item has-dropdown is-hoverable">
<a class="navbar-link" href="#">Guides</a>
<div class="navbar-dropdown">
<span class="navbar-item navbar-heading">Development</span>
<a class="navbar-item" href="../../../setupguide/latest/about.html">Setup Guide</a>
<hr class="navbar-divider"/>
<span class="navbar-item navbar-heading">Core</span>
<a class="navbar-item" href="../../../userguide/latest/about.html">User Guide</a>
<a class="navbar-item" href="../../../refguide/latest/about.html">Reference Guide</a>
<a class="navbar-item" href="../../../testing/latest/about.html">Testing Guide</a>
</div>
</div>
<div class="navbar-item has-dropdown is-hoverable">
<a class="navbar-link" href="#">Libraries</a>
<div class="navbar-dropdown">
<span class="navbar-item navbar-heading">For Use in Apps</span>
<a class="navbar-item" href="../../../subdomains/latest/about.html">Subdomain Libraries</a>
<a class="navbar-item" href="../../../valuetypes/latest/about.html">Value Types</a>
<hr class="navbar-divider"/>
<span class="navbar-item navbar-heading">Integrate between Apps</span>
<a class="navbar-item" href="../../../mappings/latest/about.html">Bounded Context Mapping Libraries</a>
<hr class="navbar-divider"/>
<span class="navbar-item navbar-heading">Other</span>
<a class="navbar-item" href="../../../incubator/latest/about.html">Incubator</a>
<a class="navbar-item" href="../../../legacy/latest/about.html">Legacy</a>
</div>
</div>
<div class="navbar-item has-dropdown is-hoverable">
<a class="navbar-link" href="#">Components</a>
<div class="navbar-dropdown">
<span class="navbar-item navbar-heading">Viewers</span>
<a class="navbar-item" href="../../../vw/latest/about.html">Wicket UI</a>
<a class="navbar-item" href="../../../vro/latest/about.html">Restful Objects (REST)</a>
<hr class="navbar-divider"/>
<span class="navbar-item navbar-heading">Security</span>
<a class="navbar-item" href="../../../security/latest/about.html">Security Guide</a>
<hr class="navbar-divider"/>
<span class="navbar-item navbar-heading">Persistence</span>
<a class="navbar-item" href="../../../pjdo/latest/about.html">DataNucleus (JDO)</a>
<hr class="navbar-divider"/>
<span class="navbar-item navbar-heading">Extensions</span>
<a class="navbar-item" href="../../../extensions/latest/about.html">Extensions Catalog</a>
</div>
</div>
<div class="navbar-item has-dropdown is-hoverable">
<a class="navbar-link" href="#">Support</a>
<div class="navbar-dropdown">
<span class="navbar-item navbar-heading">Contact</span>
<a class="navbar-item" href="../../../docs/latest/support/slack-channel.html">Slack</a>
<a class="navbar-item" href="../../../docs/latest/support/mailing-list.html">Mailing Lists</a>
<a class="navbar-item" href="https://issues.apache.org/jira/browse/ISIS">JIRA</a>
<a class="navbar-item" href="https://stackoverflow.com/questions/tagged/isis">Stack Overflow</a>
<hr class="navbar-divider"/>
<span class="navbar-item navbar-heading">Releases</span>
<a class="navbar-item" href="../../../docs/latest/downloads/how-to.html">Downloads</a>
<a class="navbar-item" href="../../../relnotes/latest/about.html">Release Notes</a>
<a class="navbar-item" href="../../../docs/latest/archive/1-x.html">Archive (1.x)</a>
<hr class="navbar-divider"/>
<span class="navbar-item navbar-heading">Framework</span>
<a class="navbar-item" href="../../../conguide/latest/about.html">Contributors' Guide</a>
<a class="navbar-item" href="../../../comguide/latest/about.html">Committers' Guide</a>
<a class="navbar-item" href="../../../core/latest/about.html">Core Design</a>
</div>
</div>
<div class="navbar-item has-dropdown is-hoverable">
<a class="navbar-link" href="#">ASF</a>
<div class="navbar-dropdown">
<a class="navbar-item" href="http://www.apache.org/">Apache Homepage</a>
<a class="navbar-item" href="https://www.apache.org/events/current-event">Events</a>
<a class="navbar-item" href="https://www.apache.org/licenses/">Licenses</a>
<a class="navbar-item" href="https://www.apache.org/security/">Security</a>
<a class="navbar-item" href="https://www.apache.org/foundation/sponsorship.html">Sponsorship</a>
<a class="navbar-item" href="https://www.apache.org/foundation/thanks.html">Thanks</a>
<hr class="navbar-divider"/>
<a class="navbar-item" href="https://whimsy.apache.org/board/minutes/Isis.html">PMC board minutes</a>
</div>
</div>
<a class="navbar-item" href="../../../docs/latest/about.html">
<span class="icon">
<img src="../../../_/img/home.png"></img>
</span>
</a>
</div>
</div>
</nav>
</header>
<div class="body ">
<div class="nav-container" data-component="refguide" data-version="2.0.0-M3">
<aside class="nav">
<div class="panels">
<div class="nav-panel-pagination">
<a class="page-previous disabled" rel="prev" href="" title=""><span></span></a>
<a class="page-next disabled" rel="next"
href="" title=""><span></span></a>
<!--
page.parent doesn't seem to be set...
<a class="page-parent disabled" rel="prev" href="" title=""><span></span></a>
-->
</div>
<div class="nav-panel-menu is-active" data-panel="menu">
<nav class="nav-menu">
<h3 class="title"><a href="../about.html">Reference Guide</a></h3>
<ul class="nav-list">
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../../latest/applib-ant/about.html">Annotations</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-ant/Action.html">Action</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-ant/ActionLayout.html">ActionLayout</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-ant/Collection.html">Collection</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-ant/CollectionLayout.html">CollectionLayout</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-ant/Column.html">Column</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-ant/Digits.html">Digits</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-ant/Discriminator.html">Discriminator</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-ant/DomainObject.html">DomainObject</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-ant/DomainObjectLayout.html">DomainObjectLayout</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-ant/DomainService.html">DomainService</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-ant/DomainServiceLayout.html">DomainServiceLayout</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-ant/Facets.html">Facets</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-ant/HomePage.html">HomePage</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-ant/MemberOrder.html">MemberOrder</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-ant/Mixin.html">Mixin</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-ant/NotPersistent.html">NotPersistent.</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-ant/Nullable.html">Nullable</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-ant/MinLength.html">MinLength</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-ant/Parameter.html">Parameter</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-ant/ParameterLayout.html">ParameterLayout</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-ant/Pattern.html">Pattern</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-ant/PersistenceCapable.html">PersistenceCapable</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-ant/PrimaryKey.html">PrimaryKey</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-ant/Programmatic.html">Programmatic</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-ant/Property.html">Property</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-ant/PropertyLayout.html">PropertyLayout</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-ant/IsisSessionScope.html">RequestScoped</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-ant/Title.html">Title</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-ant/ViewModel.html">ViewModel</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-ant/XmlJavaTypeAdapter.html">XmlJavaTypeAdapter</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-ant/XmlRootElement.html">XmlRootElement</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../../latest/applib-methods/about.html">Methods</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-methods/prefixes.html">Supporting Method Prefixes</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-methods/reserved.html">Reserved Methods</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-methods/lifecycle.html">Lifecycle Methods</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../applib-classes/about.html">Classes</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../applib-classes/events.html">Events</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../applib-classes/ViewModel.html"><code>ViewModel</code></a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../applib-classes/value-types.html">Value Types</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../applib-classes/spec.html">Specification pattern</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../applib-classes/i18n.html">i18n support</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../applib-classes/roles-mixins-contributees.html">Roles, Mixins and Contributees</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../applib-classes/utility.html">Utility Classes</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../applib-classes/layout.html">Layout</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../../latest/applib-svc/about.html">Domain Services</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-svc/AcceptHeaderService.html">AcceptHeaderService</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-svc/ApplicationFeatureRepository.html">ApplicationFeatureRepository</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-svc/AuditerService.html">AuditerService</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-svc/BookmarkService.html">BookmarkService</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-svc/BookmarkUiService.html">BookmarkUiService</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-svc/ClockService.html">ClockService</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-svc/CommandContext.html">CommandContext</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-svc/CommandDtoProcessorService.html">CommandDtoProcessorService</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-svc/CommandExecutorService.html">CommandExecutorService</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-svc/CommandService.html">CommandService</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-svc/ConfigurationMenu.html">ConfigurationMenu</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-svc/ConfigurationViewService.html">ConfigurationViewService</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-svc/ContentMappingService.html">ContentMappingService</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-svc/DeepLinkService.html">DeepLinkService</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-svc/EmailNotificationService.html">EmailNotificationService</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-svc/EmailService.html">EmailService</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-svc/ErrorReportingService.html">ErrorReportingService</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-svc/EventBusService.html">EventBusService</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-svc/ExceptionRecognizerService.html">ExceptionRecognizerService</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-svc/FactoryService.html">FactoryService</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-svc/GridLoaderService.html">GridLoaderService</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-svc/GridService.html">GridService</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-svc/GridSystemService.html">GridSystemService</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-svc/HealthCheckService.html">HealthCheckService</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-svc/HintStore.html">HintStore</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-svc/HomePageResolverService.html">HomePageResolverService</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-svc/InteractionContext.html">InteractionContext</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-svc/JaxbService.html">JaxbService</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-svc/LayoutService.html">LayoutService</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-svc/LayoutServiceMenu.html">LayoutServiceMenu</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-svc/LocaleProvider.html">LocaleProvider</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-svc/MenuBarsLoaderService.html">MenuBarsLoaderService</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-svc/MenuBarsService.html">MenuBarsService</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-svc/MessageService.html">MessageService</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-svc/MetaModelService.html">MetamodelService</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-svc/MetaModelServiceMenu.html">MetamodelServiceMenu</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-svc/MetricsService.html">MetricsService</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-svc/PublisherService.html">PublisherService</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-svc/QueryResultsCache.html">QueryResultsCache</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-svc/RepositoryService.html">RepositoryService</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-svc/RoutingService.html">RoutingService</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-svc/Scratchpad.html">Scratchpad</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-svc/ServiceInjector.html">ServiceInjector</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-svc/ServiceRegistry.html">ServiceRegistry</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-svc/SessionLoggingService.html">SessionLoggingService</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-svc/SudoService.html">SudoService</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-svc/SwaggerService.html">SwaggerService</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-svc/TableColumnOrderService.html">TableColumnOrderService</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-svc/TitleService.html">TitleService</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-svc/TranslationService.html">TranslationService</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-svc/TranslationsResolver.html">TranslationsResolver</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-svc/TransactionService.html">TransactionService</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-svc/UrlEncodingService.html">UrlEncodingService</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-svc/UserProfileService.html">UserProfileService</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-svc/UserRegistrationService.html">UserRegistrationService</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-svc/UserService.html">UserService</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-svc/WrapperFactory.html">WrapperFactory</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-svc/XmlService.html">XmlService</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/applib-svc/XmlSnapshotService.html">XmlSnapshotService</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../../latest/config/about.html">Configuration</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/config/sections/isis.persistence.jdo-datanucleus.impl.html">DataNucleus Configuration</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/config/sections/isis.value-types.html">Value types</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/config/sections/resteasy.html">RestEasy Configuration</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/config/sections/Other.html">Other</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../../latest/schema/about.html">Schema</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/schema/mml.html">MetaModel</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/schema/cmd.html">Command</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/schema/ixn.html">Interaction</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/schema/chg.html">Changes</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../../latest/schema/common.html">Common</a>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</nav>
</div>
<div class="nav-panel-explore" data-panel="explore">
<div class="context">
<span class="title">Reference Guide</span>
<span class="version">2.0.0-M3</span>
</div>
<ul class="components">
<li class="component">
<span class="title"> </span>
<ul class="versions">
<li class="version is-latest">
<a href="../../../docs/latest/about.html">latest</a>
</li>
<li class="version">
<a href="../../../docs/2.0.0-M3/about.html">2.0.0-M3</a>
</li>
</ul>
</li>
<li class="component">
<span class="title">BC Mappings Catalog</span>
<ul class="versions">
<li class="version is-latest">
<a href="../../../mappings/latest/about.html">latest</a>
</li>
<li class="version">
<a href="../../../mappings/2.0.0-M3/about.html">2.0.0-M3</a>
</li>
</ul>
</li>
<li class="component">
<span class="title">Committers' Guide</span>
<ul class="versions">
<li class="version is-latest">
<a href="../../../comguide/latest/about.html">latest</a>
</li>
<li class="version">
<a href="../../../comguide/2.0.0-M3/about.html">2.0.0-M3</a>
</li>
</ul>
</li>
<li class="component">
<span class="title">Contributors' Guide</span>
<ul class="versions">
<li class="version is-latest">
<a href="../../../conguide/latest/about.html">latest</a>
</li>
<li class="version">
<a href="../../../conguide/2.0.0-M3/about.html">2.0.0-M3</a>
</li>
</ul>
</li>
<li class="component">
<span class="title">Core Framework</span>
<ul class="versions">
<li class="version is-latest">
<a href="../../../core/latest/about.html">latest</a>
</li>
<li class="version">
<a href="../../../core/2.0.0-M3/about.html">2.0.0-M3</a>
</li>
</ul>
</li>
<li class="component">
<span class="title">Extensions Catalog</span>
<ul class="versions">
<li class="version is-latest">
<a href="../../../extensions/latest/about.html">latest</a>
</li>
<li class="version">
<a href="../../../extensions/2.0.0-M3/about.html">2.0.0-M3</a>
</li>
</ul>
</li>
<li class="component">
<span class="title">Incubator Catalog</span>
<ul class="versions">
<li class="version is-latest">
<a href="../../../incubator/latest/about.html">latest</a>
</li>
<li class="version">
<a href="../../../incubator/2.0.0-M3/about.html">2.0.0-M3</a>
</li>
</ul>
</li>
<li class="component">
<span class="title">JDO/DataNucleus</span>
<ul class="versions">
<li class="version is-latest">
<a href="../../../pjdo/latest/about.html">latest</a>
</li>
<li class="version">
<a href="../../../pjdo/2.0.0-M3/about.html">2.0.0-M3</a>
</li>
</ul>
</li>
<li class="component">
<span class="title">Legacy Catalog</span>
<ul class="versions">
<li class="version is-latest">
<a href="../../../legacy/latest/about.html">latest</a>
</li>
<li class="version">
<a href="../../../legacy/2.0.0-M3/about.html">2.0.0-M3</a>
</li>
</ul>
</li>
<li class="component is-current">
<span class="title">Reference Guide</span>
<ul class="versions">
<li class="version is-latest">
<a href="../../latest/about.html">latest</a>
</li>
<li class="version is-current">
<a href="../about.html">2.0.0-M3</a>
</li>
</ul>
</li>
<li class="component">
<span class="title">Release Notes</span>
<ul class="versions">
<li class="version is-latest">
<a href="../../../relnotes/latest/about.html">latest</a>
</li>
<li class="version">
<a href="../../../relnotes/2.0.0-M3/about.html">2.0.0-M3</a>
</li>
</ul>
</li>
<li class="component">
<span class="title">Restful Objects Viewer</span>
<ul class="versions">
<li class="version is-latest">
<a href="../../../vro/latest/about.html">latest</a>
</li>
<li class="version">
<a href="../../../vro/2.0.0-M3/about.html">2.0.0-M3</a>
</li>
</ul>
</li>
<li class="component">
<span class="title">Security Guide</span>
<ul class="versions">
<li class="version is-latest">
<a href="../../../security/latest/about.html">latest</a>
</li>
<li class="version">
<a href="../../../security/2.0.0-M3/about.html">2.0.0-M3</a>
</li>
</ul>
</li>
<li class="component">
<span class="title">Setup Guide</span>
<ul class="versions">
<li class="version is-latest">
<a href="../../../setupguide/latest/about.html">latest</a>
</li>
<li class="version">
<a href="../../../setupguide/2.0.0-M3/about.html">2.0.0-M3</a>
</li>
</ul>
</li>
<li class="component">
<span class="title">Subdomains Catalog</span>
<ul class="versions">
<li class="version is-latest">
<a href="../../../subdomains/latest/about.html">latest</a>
</li>
<li class="version">
<a href="../../../subdomains/2.0.0-M3/about.html">2.0.0-M3</a>
</li>
</ul>
</li>
<li class="component">
<span class="title">Testing Guide</span>
<ul class="versions">
<li class="version is-latest">
<a href="../../../testing/latest/about.html">latest</a>
</li>
<li class="version">
<a href="../../../testing/2.0.0-M3/about.html">2.0.0-M3</a>
</li>
</ul>
</li>
<li class="component">
<span class="title">User Guide</span>
<ul class="versions">
<li class="version is-latest">
<a href="../../../userguide/latest/about.html">latest</a>
</li>
<li class="version">
<a href="../../../userguide/2.0.0-M3/about.html">2.0.0-M3</a>
</li>
</ul>
</li>
<li class="component">
<span class="title">Value Types Catalog</span>
<ul class="versions">
<li class="version is-latest">
<a href="../../../valuetypes/latest/about.html">latest</a>
</li>
<li class="version">
<a href="../../../valuetypes/2.0.0-M3/about.html">2.0.0-M3</a>
</li>
</ul>
</li>
<li class="component">
<span class="title">Wicket Viewer</span>
<ul class="versions">
<li class="version is-latest">
<a href="../../../vw/latest/about.html">latest</a>
</li>
<li class="version">
<a href="../../../vw/2.0.0-M3/about.html">2.0.0-M3</a>
</li>
</ul>
</li>
</ul>
</div>
</div>
</aside>
</div>
<main role="main">
<div class="toolbar" role="navigation">
<button class="nav-toggle"></button>
<a href="../../../docs/latest/about.html" class="home-link"></a>
<nav class="breadcrumbs" aria-label="breadcrumbs">
<ul>
<li><a href="../about.html">Reference Guide</a></li>
<li><a href="ActionLayout.html"><code>@ActionLayout</code></a></li>
</ul>
</nav>
<div class="page-versions">
<button class="version-menu-toggle" title="Show other versions of page">2.0.0-M3</button>
<div class="version-menu">
<a class="version" href="../../latest/applib-ant/ActionLayout.html">latest</a>
<a class="version is-current" href="ActionLayout.html">2.0.0-M3</a>
</div>
</div>
<div class="edit-this-page"><a href="https://github.com/apache/isis/blob/docs/isis-2.0.0-M3/api/applib/src/main/adoc/modules/applib-ant/pages/ActionLayout.adoc">Edit</a></div>
</div>
<article class="doc">
<a name="section-top"></a>
<h1 class="page"><code>@ActionLayout</code></h1>
<div id="preamble">
<div class="sectionbody">
<div class="paragraph">
<p>The <code>@ActionLayout</code> annotation applies to actions, collecting together all UI hints within a single annotation.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-java hljs" data-lang="java">@Inherited
@Target({
ElementType.METHOD,
ElementType.TYPE,
ElementType.ANNOTATION_TYPE
})
@Retention(RetentionPolicy.RUNTIME)
@Mixin(method = "act")
public @interface ActionLayout {
BookmarkPolicy bookmarking() <i class="conum" data-value="1"></i><b>(1)</b>
default BookmarkPolicy.NOT_SPECIFIED;
String cssClass() <i class="conum" data-value="2"></i><b>(2)</b>
default "";
String cssClassFa() <i class="conum" data-value="3"></i><b>(3)</b>
default "";
CssClassFaPosition cssClassFaPosition() <i class="conum" data-value="4"></i><b>(4)</b>
default CssClassFaPosition.LEFT;
String describedAs() <i class="conum" data-value="5"></i><b>(5)</b>
default "";
Where hidden() <i class="conum" data-value="6"></i><b>(6)</b>
default Where.NOT_SPECIFIED;
String named() <i class="conum" data-value="7"></i><b>(7)</b>
default "";
Position position() <i class="conum" data-value="8"></i><b>(8)</b>
default Position.NOT_SPECIFIED;
PromptStyle promptStyle() <i class="conum" data-value="9"></i><b>(9)</b>
default PromptStyle.AS_CONFIGURED;
Redirect redirectPolicy() <i class="conum" data-value="10"></i><b>(10)</b>
default Redirect.AS_CONFIGURED;
}</code></pre>
</div>
</div>
<div class="colist arabic">
<table>
<tr>
<td><i class="conum" data-value="1"></i><b>1</b></td>
<td><a href="../../latest/applib-ant/ActionLayout.html#bookmarking" class="page"><code>bookmarking()</code></a>
<div class="paragraph">
<p>Indicates if an action (with safe <a href="../../latest/applib-ant/Action.html#semantics" class="page">action semantics</a>) is automatically bookmarked.</p>
</div></td>
</tr>
<tr>
<td><i class="conum" data-value="2"></i><b>2</b></td>
<td><a href="../../latest/applib-ant/ActionLayout.html#cssClass" class="page"><code>cssClass()</code></a>
<div class="paragraph">
<p>An additional CSS class around the HTML that represents for the action, to allow targetted styling in <a href="../../latest/config/application-specific/application-css.html" class="page"><code>application.css</code></a>.<br></p>
</div></td>
</tr>
<tr>
<td><i class="conum" data-value="3"></i><b>3</b></td>
<td><a href="../../latest/applib-ant/ActionLayout.html#cssClassFa" class="page"><code>cssClassFa()</code></a>
<div class="paragraph">
<p>Specify a <a href="http://fortawesome.github.io/Font-Awesome/">Font awesome</a> icon name for the action&#8217;s menu link or icon.</p>
</div></td>
</tr>
<tr>
<td><i class="conum" data-value="4"></i><b>4</b></td>
<td><code>cssClassFaPosition()</code>
<div class="paragraph">
<p>Positioning of the icon on the button/menu item.</p>
</div></td>
</tr>
<tr>
<td><i class="conum" data-value="5"></i><b>5</b></td>
<td><a href="../../latest/applib-ant/ActionLayout.html#describedAs" class="page"><code>describedAs()</code></a>
<div class="paragraph">
<p>Provides a short description of the action, eg for rendering as a 'tool tip'.</p>
</div></td>
</tr>
<tr>
<td><i class="conum" data-value="6"></i><b>6</b></td>
<td><a href="../../latest/applib-ant/ActionLayout.html#hidden" class="page"><code>hidden()</code></a>
<div class="paragraph">
<p>Indicates where (in the UI) the action should be hidden from the user.</p>
</div></td>
</tr>
<tr>
<td><i class="conum" data-value="7"></i><b>7</b></td>
<td><a href="../../latest/applib-ant/ActionLayout.html#named" class="page"><code>named()</code></a>
<div class="paragraph">
<p>To override the name inferred from the action&#8217;s name in code.<br>
A typical use case is if the desired name is a reserved Java keyword, such as <code>default</code> or <code>package</code>.</p>
</div></td>
</tr>
<tr>
<td><i class="conum" data-value="8"></i><b>8</b></td>
<td><a href="../../latest/applib-ant/ActionLayout.html#position" class="page"><code>position()</code></a>
<div class="paragraph">
<p>For actions associated (using <a href="../../latest/applib-ant/MemberOrder.html" class="page"><code>@MemberOrder#named</code></a>) with properties, the positioning of the action&#8217;s button with respect to the property</p>
</div></td>
</tr>
<tr>
<td><i class="conum" data-value="9"></i><b>9</b></td>
<td><code>promptStyle()</code>
<div class="paragraph">
<p>How to render the action prompt / property edit form : inline, dialog, sidebar etc.</p>
</div></td>
</tr>
<tr>
<td><i class="conum" data-value="10"></i><b>10</b></td>
<td><code>redirectPolicy()</code>
<div class="paragraph">
<p>For the <a href="../../../vw/latest/about.html" class="page">Wicket viewer</a>, whether to re-render the page after invoking this action, even if the result is the same.</p>
</div>
<div class="paragraph">
<p>Not re-rendering can provide a smoother UI experience.</p>
</div></td>
</tr>
</table>
</div>
<div class="paragraph">
<p>For example:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-java hljs" data-lang="java">public class ToDoItems {
@Action(semantics=SemanticsOf.SAFE) <i class="conum" data-value="1"></i><b>(1)</b>
@ActionLayout(
bookmarking=BookmarkPolicy.AS_ROOT,
cssClass="x-key",
cssClassFa="fa-checkbox",
describedAs="Mark the todo item as not complete after all",
hidden=Where.NOWHERE <i class="conum" data-value="2"></i><b>(2)</b>
)
@MemberOrder(sequence = "1")
public List&lt;ToDoItem&gt; notYetComplete() {
...
}
}</code></pre>
</div>
</div>
<div class="colist arabic">
<table>
<tr>
<td><i class="conum" data-value="1"></i><b>1</b></td>
<td>required for bookmarkable actions</td>
</tr>
<tr>
<td><i class="conum" data-value="2"></i><b>2</b></td>
<td>default value, so could be omitted</td>
</tr>
</table>
</div>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
<div class="paragraph">
<p>As an alternative to using the <code>@ActionLayout</code> annotation, a <a href="../../../userguide/latest/fun/ui.html#object-layout" class="page">file-based layout</a> can be used (and is generally to be preferred since it is more flexible/powerful).</p>
</div>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="sect1">
<h2 id="bookmarking"><a class="anchor" href="#bookmarking"></a><code>bookmarking()</code></h2>
<div class="sectionbody">
<div class="paragraph">
<p>The <code>bookmarking</code> attribute indicates if an action (with safe <a href="../../latest/applib-ant/Action.html#semantics" class="page">action semantics</a>) is automatically bookmarked.</p>
</div>
<div class="paragraph">
<p>In the <a href="../../../vw/latest/about.html" class="page">Wicket viewer</a>, a link to a bookmarked object is shown in the bookmarks panel:</p>
</div>
<div class="imageblock">
<div class="content">
<a class="image" href="_images/reference-annotations/ActionLayout/bookmarking.png"><img src="_images/reference-annotations/ActionLayout/bookmarking.png" alt="bookmarking" width="720px"></a>
</div>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
<div class="paragraph">
<p>Note that this screenshot shows an earlier version of the <a href="../../../vw/latest/about.html" class="page">Wicket viewer</a> UI (specifically, pre 1.8.0).</p>
</div>
</td>
</tr>
</table>
</div>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
<div class="paragraph">
<p>The <a href="../../../vw/latest/about.html" class="page">Wicket viewer</a> supports <code>alt-[</code> as a shortcut for opening the bookmark panel. <code>Esc</code> will close.</p>
</div>
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>For example:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-java hljs" data-lang="java">public class ToDoItems {
@Action(semantics=SemanticsOf.SAFE)
@ActionLayout(bookmarking=BookmarkPolicy.AS_ROOT)
@MemberOrder(sequence = "1")
public List&lt;ToDoItem&gt; notYetComplete() {
...
}
}</code></pre>
</div>
</div>
<div class="paragraph">
<p>indicates that the <code>notYetComplete()</code> action is bookmarkable.</p>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
<div class="paragraph">
<p>The enum value <code>AS_CHILD</code> has no meaning for actions; it relates only to bookmarked <a href="../../latest/applib-ant/DomainObjectLayout.html#bookmarking" class="page">domain object</a>s.</p>
</div>
</td>
</tr>
</table>
</div>
<div class="sect2">
<h3 id="alternatives"><a class="anchor" href="#alternatives"></a>Alternatives</h3>
<div class="paragraph">
<p>As an alternative to using the annotation, the dynamic <a href="../../../userguide/latest/fun/ui.html#object-layout" class="page">file-based layout</a> can be used instead.</p>
</div>
</div>
<div class="sect2">
<h3 id="see-also"><a class="anchor" href="#see-also"></a>See also</h3>
<div class="paragraph">
<p>This attribute is also supported for <a href="../../latest/applib-ant/DomainObjectLayout.html#bookmarking" class="page">domain objects</a>.</p>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="contributedAs"><a class="anchor" href="#contributedAs"></a><code>contributedAs()</code></h2>
<div class="sectionbody">
<div class="paragraph">
<p>For mixin actions that could qualify as derived properties or collections, the <code>contributedAs</code> attribute determines <em>how</em> it is contributed.</p>
</div>
<div class="paragraph">
<p>For example:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-java hljs" data-lang="java">public class Customer {
@Mixin
public class mostRecentOrders { <i class="conum" data-value="1"></i><b>(1)</b>
@Action(semantics=SemanticsOf.SAFE)
@ActionLayout(contributedAs=Contributed.AS_ASSOCIATION) <i class="conum" data-value="2"></i><b>(2)</b>
public List&lt;Order&gt; $$() {
// ...
}
// ...
}
}</code></pre>
</div>
</div>
<div class="colist arabic">
<table>
<tr>
<td><i class="conum" data-value="1"></i><b>1</b></td>
<td>mixin as a nested (non-static) class</td>
</tr>
<tr>
<td><i class="conum" data-value="2"></i><b>2</b></td>
<td>contributed as an association, that is, a collection.</td>
</tr>
</table>
</div>
</div>
</div>
<div class="sect1">
<h2 id="cssClass"><a class="anchor" href="#cssClass"></a><code>cssClass()</code></h2>
<div class="sectionbody">
<div class="paragraph">
<p>The <code>cssClass</code> attribute can be used to render additional CSS classes in the HTML (a wrapping <code>&lt;div&gt;</code>) that represents the action.
<a href="../../latest/config/application-specific/application-css.html" class="page">Application-specific CSS</a> can then be used to target and adjust the UI representation of that particular element.</p>
</div>
<div class="paragraph">
<p>For example:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-java hljs" data-lang="java">public class ToDoItem {
@ActionLayout(cssClass="x-key")
public ToDoItem postpone(LocalDate until) { /* ... */ }
...
}</code></pre>
</div>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
<div class="paragraph">
<p>The similar <a href="../../latest/applib-ant/ActionLayout.html#cssClassFa" class="page"><code>@ActionLayout#cssClassFa</code></a> annotation attribute is also used as a hint to apply CSS, specifically to add <a href="http://fortawesome.github.io/Font-Awesome/icons/">Font Awesome icons</a> on action menu items or buttons.</p>
</div>
</td>
</tr>
</table>
</div>
<div class="sect2">
<h3 id="alternatives-2"><a class="anchor" href="#alternatives-2"></a>Alternatives</h3>
<div class="paragraph">
<p>As an alternative to using the annotation, the dynamic <a href="../../../userguide/latest/fun/ui.html#object-layout" class="page">file-based layout</a> can be used instead.</p>
</div>
</div>
<div class="sect2">
<h3 id="see-also-2"><a class="anchor" href="#see-also-2"></a>See also</h3>
<div class="paragraph">
<p>This attribute can also be applied to:</p>
</div>
<div class="ulist">
<ul>
<li>
<p><a href="../../latest/applib-ant/DomainObjectLayout.html#cssClass" class="page">domain objects</a></p>
</li>
<li>
<p><a href="../../latest/applib-ant/PropertyLayout.html#cssClass" class="page">properties</a></p>
</li>
<li>
<p><a href="../../latest/applib-ant/CollectionLayout.html#cssClass" class="page">collections</a></p>
</li>
<li>
<p><a href="../../latest/applib-ant/ParameterLayout.html#cssClass" class="page">parameters</a>.</p>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="cssClassFa"><a class="anchor" href="#cssClassFa"></a><code>cssClassFa()</code></h2>
<div class="sectionbody">
<div class="paragraph">
<p>The <code>cssClassFa</code> attribute is used to specify the name of a <a href="http://fortawesome.github.io/Font-Awesome/icons/">Font Awesome icon</a> name, to be rendered on the action&#8217;s representation as a button or menu item.
The related <code>cssClassFaPosition</code> attribute specifies the positioning of the icon, to the left or the right of the text.</p>
</div>
<div class="paragraph">
<p>These attributes can also be applied to <a href="../../latest/applib-ant/DomainObjectLayout.html#cssClassFa" class="page">domain objects</a> to specify the object&#8217;s icon.</p>
</div>
<div class="paragraph">
<p>For example:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-java hljs" data-lang="java">public class ToDoItem {
@ActionLayout(
cssClassFa="fa-step-backward"
)
public ToDoItem previous() {
// ...
}
@ActionLayout(
cssClassFa="fa-step-forward",
cssClassFaPosition=ActionLayout.CssClassFaPosition.RIGHT
)
public ToDoItem next() {
// ...
}
}</code></pre>
</div>
</div>
<div class="paragraph">
<p>There can be multiple "fa-" classes, eg to mirror or rotate the icon.
There is no need to include the mandatory <code>fa</code> "marker" CSS class; it will be automatically added to the list.
The <code>fa-</code> prefix can also be omitted from the class names; it will be prepended to each if required.</p>
</div>
<div class="sect2">
<h3 id="alternatives-3"><a class="anchor" href="#alternatives-3"></a>Alternatives</h3>
<div class="paragraph">
<p>As an alternative to using the annotation, the dynamic <a href="../../../userguide/latest/fun/ui.html#object-layout" class="page">file-based layout</a> can be used instead.</p>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
<div class="paragraph">
<p>The similar <a href="../../latest/applib-ant/ActionLayout.html#cssClass" class="page"><code>@ActionLayout#cssClass</code></a> annotation attribute is also used as a hint to apply CSS, but for wrapping the representation of an object or object member so that it can be styled in an application-specific way.</p>
</div>
</td>
</tr>
</table>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="describedAs"><a class="anchor" href="#describedAs"></a><code>describedAs()</code></h2>
<div class="sectionbody">
<div class="paragraph">
<p>The <code>describedAs</code> attribute is used to provide a short description of the action to the user.
In the <a href="../../../vw/latest/about.html" class="page">Wicket viewer</a> it is displayed as a 'tool tip'.</p>
</div>
<div class="paragraph">
<p>For example:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-java hljs" data-lang="java">public class Customer {
@ActionLayout(describedAs=
"Place a repeat order of the last (most recently placed) order")
public Order placeRepeatOrder(...) { /* ... */ }
}</code></pre>
</div>
</div>
<div class="sect2">
<h3 id="alternatives-4"><a class="anchor" href="#alternatives-4"></a>Alternatives</h3>
<div class="paragraph">
<p>As an alternative to using the annotation, the dynamic <a href="../../../userguide/latest/fun/ui.html#object-layout" class="page">file-based layout</a> can be used instead.</p>
</div>
</div>
<div class="sect2">
<h3 id="see-also-3"><a class="anchor" href="#see-also-3"></a>See also</h3>
<div class="paragraph">
<p>This attribute can also be specified for:</p>
</div>
<div class="ulist">
<ul>
<li>
<p><a href="../../latest/applib-ant/CollectionLayout.html#describedAs" class="page">collections</a></p>
</li>
<li>
<p><a href="../../latest/applib-ant/PropertyLayout.html#describedAs" class="page">properties</a></p>
</li>
<li>
<p><a href="../../latest/applib-ant/ParameterLayout.html#describedAs" class="page">parameters</a></p>
</li>
<li>
<p><a href="../../latest/applib-ant/DomainObjectLayout.html#describedAs" class="page">domain objects</a></p>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="hidden"><a class="anchor" href="#hidden"></a><code>hidden()</code></h2>
<div class="sectionbody">
<div class="paragraph">
<p>The <code>hidden</code> attribute indicates where (in the UI) the action should be hidden from the user.</p>
</div>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
<div class="paragraph">
<p>It is also possible to use <a href="../../latest/applib-ant/Action.html#hidden" class="page"><code>@Action#hidden</code></a> to hide an action at the domain layer.</p>
</div>
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>For example:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-java hljs" data-lang="java">public class Customer {
@ActionLayout(hidden=Where.EVERYWHERE)
public void updateStatus() {
// ...
}
...
}</code></pre>
</div>
</div>
<div class="paragraph">
<p>The acceptable values for the <code>where</code> parameter are:</p>
</div>
<div class="ulist">
<ul>
<li>
<p><code>Where.EVERYWHERE</code> or <code>Where.ANYWHERE</code></p>
<div class="paragraph">
<p>The action should be hidden at all times.</p>
</div>
</li>
<li>
<p><code>Where.NOWHERE</code></p>
<div class="paragraph">
<p>The action should not be hidden.</p>
</div>
</li>
</ul>
</div>
<div class="paragraph">
<p>The other values of the <code>Where</code> enum have no meaning for a collection.</p>
</div>
<div class="sect2">
<h3 id="alternatives-5"><a class="anchor" href="#alternatives-5"></a>Alternatives</h3>
<div class="paragraph">
<p>As an alternative to using the annotation, the dynamic <a href="../../../userguide/latest/fun/ui.html#object-layout" class="page">file-based layout</a> can be used instead.</p>
</div>
</div>
<div class="sect2">
<h3 id="see-also-4"><a class="anchor" href="#see-also-4"></a>See also</h3>
<div class="paragraph">
<p>This attribute can also be applied to:
* <a href="../../latest/applib-ant/PropertyLayout.html#hidden" class="page">properties</a>
* <a href="../../latest/applib-ant/CollectionLayout.html#hidden" class="page">collections</a>.</p>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="named"><a class="anchor" href="#named"></a><code>named()</code></h2>
<div class="sectionbody">
<div class="paragraph">
<p>The <code>named</code> attribute explicitly specifies the action&#8217;s name, overriding the name that would normally be inferred from the Java source code.</p>
</div>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
<div class="paragraph">
<p>Only use this attribute when the desired name cannot be used in Java source code.
Examples of that include a name that would be a reserved Java keyword (eg "package"), or a name that has punctuation, eg apostrophes.</p>
</div>
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>For example:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-java hljs" data-lang="java">public class Customer {
@ActionLayout(named="Get credit rating") <i class="conum" data-value="1"></i><b>(1)</b>
public CreditRating obtainCreditRating() {
// ...
}
}</code></pre>
</div>
</div>
<div class="colist arabic">
<table>
<tr>
<td><i class="conum" data-value="1"></i><b>1</b></td>
<td>"get" normally indicates a property rather than an action.</td>
</tr>
</table>
</div>
<div class="sect2">
<h3 id="alternatives-6"><a class="anchor" href="#alternatives-6"></a>Alternatives</h3>
<div class="paragraph">
<p>As an alternative to using the annotation, the dynamic <a href="../../../userguide/latest/fun/ui.html#object-layout" class="page">file-based layout</a> can be used instead.</p>
</div>
<div class="paragraph">
<p>The framework also provides a separate, powerful mechanism for <a href="../../../userguide/latest/btb/i18n.html" class="page">internationalization</a>.</p>
</div>
</div>
<div class="sect2">
<h3 id="see-also-5"><a class="anchor" href="#see-also-5"></a>See also</h3>
<div class="paragraph">
<p>This attribute can also be specified for:</p>
</div>
<div class="ulist">
<ul>
<li>
<p><a href="../../latest/applib-ant/CollectionLayout.html#named" class="page">collections</a></p>
</li>
<li>
<p><a href="../../latest/applib-ant/PropertyLayout.html#named" class="page">properties</a></p>
</li>
<li>
<p><a href="../../latest/applib-ant/ParameterLayout.html#named" class="page">parameters</a></p>
</li>
<li>
<p><a href="../../latest/applib-ant/DomainObjectLayout.html#named" class="page">domain objects</a></p>
</li>
<li>
<p><a href="../../latest/applib-ant/DomainServiceLayout.html#named" class="page">domain services</a>.</p>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="position"><a class="anchor" href="#position"></a><code>position()</code></h2>
<div class="sectionbody">
<div class="paragraph">
<p>The <code>position</code> attribute pertains only to actions that have been associated with properties using <a href="../../latest/applib-ant/MemberOrder.html" class="page"><code>@MemberOrder#named</code></a>.
For these actions, it specifies the positioning of the action&#8217;s button with respect to the field representing the object property.</p>
</div>
<div class="paragraph">
<p>The attribute can take one of four values: <code>BELOW</code>, <code>RIGHT</code>, <code>PANEL</code> or <code>PANEL_DROPDOWN</code>.</p>
</div>
<div class="paragraph">
<p>For example:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-java hljs" data-lang="java">import lombok.Getter;
import lombok.Setter;
public class Customer {
@Property( editing=Editing.DISABLED )
@Getter @Setter
private BigDecimal cost;
@Property( editing=Editing.DISABLED )
@Getter @Setter
private String location;
@MemberOrder( named="cost" ) <i class="conum" data-value="1"></i><b>(1)</b>
@ActionLayout(
named="Update", <i class="conum" data-value="2"></i><b>(2)</b>
position=Position.BELOW <i class="conum" data-value="3"></i><b>(3)</b>
)
public Customer updateCost(BigDecimal cost ) {
// ...
}
@MemberOrder( named="location" )
@ActionLayout(
named="Update",
position=Position.BELOW
)
public Customer updateLocation(String latitude, String longitude) {
// ...
}
}</code></pre>
</div>
</div>
<div class="colist arabic">
<table>
<tr>
<td><i class="conum" data-value="1"></i><b>1</b></td>
<td>associate the "updateCost" action with the "cost" property</td>
</tr>
<tr>
<td><i class="conum" data-value="2"></i><b>2</b></td>
<td>give the action an abbreviated name, because the fact that the "cost" property is to be updated is implied by its positioning</td>
</tr>
<tr>
<td><i class="conum" data-value="3"></i><b>3</b></td>
<td>positioning of the action&#8217;s button</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>The default is <code>BELOW</code>, which is rendered (by the <a href="../../../vw/latest/about.html" class="page">Wicket viewer</a>) as shown below:</p>
</div>
<div class="imageblock">
<div class="content">
<a class="image" href="_images/reference-annotations/ActionLayout/position-BELOW.png"><img src="_images/reference-annotations/ActionLayout/position-BELOW.png" alt="position BELOW" width="720px"></a>
</div>
</div>
<div class="paragraph">
<p>If the action is positioned as <code>RIGHT</code>, then the action&#8217;s button is rendered to the right of the property&#8217;s field, in a compact drop-down.
This is ideal if there are many actions associated with a property:</p>
</div>
<div class="imageblock">
<div class="content">
<a class="image" href="_images/reference-annotations/ActionLayout/position-RIGHT.png"><img src="_images/reference-annotations/ActionLayout/position-RIGHT.png" alt="position RIGHT" width="720px"></a>
</div>
</div>
<div class="paragraph">
<p>If the action is positioned as <code>PANEL</code>, then the action&#8217;s button is rendered on the header of the panel that contains the property:</p>
</div>
<div class="imageblock">
<div class="content">
<a class="image" href="_images/reference-annotations/ActionLayout/position-PANEL.png"><img src="_images/reference-annotations/ActionLayout/position-PANEL.png" alt="position PANEL" width="720px"></a>
</div>
</div>
<div class="paragraph">
<p>And finally, if the action is positioned as <code>PANEL_DROPDOWN</code>, then the action&#8217;s button is again rendered on the panel header, but as a drop-down:</p>
</div>
<div class="imageblock">
<div class="content">
<a class="image" href="_images/reference-annotations/ActionLayout/position-PANEL_DROPDOWN.png"><img src="_images/reference-annotations/ActionLayout/position-PANEL_DROPDOWN.png" alt="position PANEL DROPDOWN" width="720px"></a>
</div>
</div>
<div class="paragraph">
<p>If there are multiple actions associated with a single property then the positioning can be mix&#8217;ed-and-match&#8217;ed as required.
If the <code>PANEL</code> or <code>PANEL_DROPDOWN</code> are used, then (as the screenshots above show) the actions from potentially multiple properties grouped by that panel will be shown together.</p>
</div>
<div class="sect2">
<h3 id="alternatives-7"><a class="anchor" href="#alternatives-7"></a>Alternatives</h3>
<div class="paragraph">
<p>As an alternative to using the annotation, the dynamic <a href="../../../userguide/latest/fun/ui.html#object-layout" class="page">file-based layout</a> can be used instead.</p>
</div>
<div class="paragraph">
<p>The fact that the layout is dynamic (does not require a rebuild/restart) is particularly useful in that the look-n-feel can be easily experimented with and adjusted.</p>
</div>
</div>
</div>
</div>
</article>
<aside class="article-aside toc" role="navigation">
<p class="toc-title">On this page</p>
<div id="article-toc"></div>
</aside>
</main>
</div>
<footer class="footer">
<div class="content">
<div class="copyright">
<p>
Copyright © 2010~2020 The Apache Software Foundation, licensed under the Apache License, v2.0.
<br/>
Apache, the Apache feather logo, Apache Isis, and the Apache Isis project logo are all trademarks of The Apache Software Foundation.
</p>
</div>
<div class="revision">
<p>Revision: SNAPSHOT</p>
</div>
</div>
</footer>
<script src="../../../_/js/site.js"></script>
<script async src="../../../_/js/vendor/highlight.js"></script>
<script src="../../../_/js/vendor/jquery-3.4.1.min.js"></script>
<script src="../../../_/js/vendor/jquery-ui-1.12.1.custom.widget-only.min.js"></script>
<script src="../../../_/js/vendor/jquery.tocify.min.js"></script>
<script>
$(function() {
$("#article-toc").tocify( {
showEffect: "slideDown",
hashGenerator: "pretty",
hideEffect: "slideUp",
selectors: "h2, h3",
scrollTo: 120,
smoothScroll: true,
theme: "jqueryui",
highlightOnScroll: true
} );
});
</script>
</body>
</html>