| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="utf-8"> |
| <meta name="viewport" content="width=device-width,initial-scale=1"> |
| <title>@CollectionLayout :: Apache Isis</title> |
| <link rel="canonical" href="https://isis.apache.org/refguide/2.0.0-M5/applib/index/annotation/CollectionLayout.html"> |
| <meta name="generator" content="Antora 2.3.4"> |
| <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="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css"/> |
| <link rel="home" href="https://isis.apache.org" title="Apache Isis"> |
| <link rel="next" href="../../../applib-ant/Column.html" title="Column"> |
| <link rel="prev" href="Collection.html" title="Collection"> |
| </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 hide-for-print"> |
| <span> |
| <input id="algolia-search-input" placeholder="Search"></span> |
| </span> |
| </div> |
| <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/2.0.0-M5/starters/helloworld.html">Hello World</a> |
| <a class="navbar-item" href="../../../../../docs/2.0.0-M5/starters/simpleapp.html">Simple App</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Demos & Tutorials</span> |
| <a class="navbar-item" href="../../../../../docs/2.0.0-M5/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/2.0.0-M5/resources/cheatsheet.html">Cheatsheet</a> |
| <a class="navbar-item" href="../../../../../docs/2.0.0-M5/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/2.0.0-M5/about.html">Setup Guide</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Core</span> |
| <a class="navbar-item" href="../../../../../userguide/2.0.0-M5/about.html">User Guide</a> |
| <a class="navbar-item" href="../../../../../refguide/2.0.0-M5/about.html">Reference Guide</a> |
| <a class="navbar-item" href="../../../../../testing/2.0.0-M5/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/2.0.0-M5/about.html">Subdomain Libraries</a> |
| <a class="navbar-item" href="../../../../../valuetypes/2.0.0-M5/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/2.0.0-M5/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/2.0.0-M5/about.html">Incubator</a> |
| <a class="navbar-item" href="../../../../../legacy/2.0.0-M5/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/2.0.0-M5/about.html">Web UI (Wicket)</a> |
| <a class="navbar-item" href="../../../../../vro/2.0.0-M5/about.html">REST API (Restful Objects)</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Security</span> |
| <a class="navbar-item" href="../../../../../security/2.0.0-M5/about.html">Security Guide</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Persistence</span> |
| <a class="navbar-item" href="../../../../../pjpa/2.0.0-M5/about.html">JPA (EclipseLink)</a> |
| <a class="navbar-item" href="../../../../../pjdo/2.0.0-M5/about.html">JDO (DataNucleus)</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Extensions</span> |
| <a class="navbar-item" href="../../../../../extensions/2.0.0-M5/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/2.0.0-M5/support/slack-channel.html">Slack</a> |
| <a class="navbar-item" href="../../../../../docs/2.0.0-M5/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/2.0.0-M5/downloads/how-to.html">Downloads</a> |
| <a class="navbar-item" href="../../../../../relnotes/2.0.0-M5/about.html">Release Notes</a> |
| <a class="navbar-item" href="../../../../../docs/2.0.0-M5/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/2.0.0-M5/about.html">Contributors' Guide</a> |
| <a class="navbar-item" href="../../../../../comguide/2.0.0-M5/about.html">Committers' Guide</a> |
| <a class="navbar-item" href="../../../../../core/2.0.0-M5/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/2.0.0-M5/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-M5"> |
| <aside class="nav"> |
| <div class="panels"> |
| <div class="nav-panel-pagination"> |
| <a class="page-previous" rel="prev" href="Collection.html" title="Collection"><span></span></a> |
| <a class="page-next" rel="next" |
| href="../../../applib-ant/Column.html" title="Column"><span></span></a> |
| <!-- |
| page.parent doesn't seem to be set... |
| <a class="page-parent" rel="prev" href="../../../applib-ant/about.html" title="Collection"><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="../../../applib-svc/about.html">Domain Services</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../services/acceptheader/AcceptHeaderService.html">AcceptHeaderService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../services/appfeat/ApplicationFeatureRepository.html">ApplicationFeatureRepository</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../services/bookmark/BookmarkService.html">BookmarkService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../services/bookmarkui/BookmarkUiService.html">BookmarkUiService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../services/clock/ClockService.html">ClockService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../services/commanddto/processor/spi/CommandDtoProcessorService.html">CommandDtoProcessorService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../services/command/CommandExecutorService.html">CommandExecutorService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../services/publishing/spi/CommandSubscriber.html">CommandSubscriber</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../services/confview/ConfigurationMenu.html">ConfigurationMenu</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../services/confview/ConfigurationViewService.html">ConfigurationViewService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../services/conmap/ContentMappingService.html">ContentMappingService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../services/linking/DeepLinkService.html">DeepLinkService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../services/userreg/EmailNotificationService.html">EmailNotificationService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../services/email/EmailService.html">EmailService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../services/publishing/spi/EntityChangesSubscriber.html">EntityChangesSubscriber</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../services/publishing/spi/EntityPropertyChangeSubscriber.html">EntityPropertyChangeSubscriber</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../services/error/ErrorReportingService.html">ErrorReportingService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../services/eventbus/EventBusService.html">EventBusService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../services/exceprecog/ExceptionRecognizerService.html">ExceptionRecognizerService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../services/factory/FactoryService.html">FactoryService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../services/grid/GridLoaderService.html">GridLoaderService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../services/grid/GridService.html">GridService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../services/grid/GridSystemService.html">GridSystemService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../services/health/HealthCheckService.html">HealthCheckService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../services/hint/HintStore.html">HintStore</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../services/homepage/HomePageResolverService.html">HomePageResolverService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../services/iactn/InteractionContext.html">InteractionContext</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../services/jaxb/JaxbService.html">JaxbService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../services/layout/LayoutService.html">LayoutService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../services/layout/LayoutServiceMenu.html">LayoutServiceMenu</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../services/i18n/LocaleProvider.html">LocaleProvider</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../services/menu/MenuBarsLoaderService.html">MenuBarsLoaderService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../services/menu/MenuBarsService.html">MenuBarsService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../services/message/MessageService.html">MessageService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../services/metamodel/MetaModelService.html">MetamodelService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../services/metamodel/MetaModelServiceMenu.html">MetamodelServiceMenu</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../services/metrics/MetricsService.html">MetricsService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../services/publishing/spi/ExecutionSubscriber.html">ExecutionSubscriber</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../services/queryresultscache/QueryResultsCache.html">QueryResultsCache</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../services/repository/RepositoryService.html">RepositoryService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../services/routing/RoutingService.html">RoutingService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../services/scratchpad/Scratchpad.html">Scratchpad</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../services/inject/ServiceInjector.html">ServiceInjector</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../services/registry/ServiceRegistry.html">ServiceRegistry</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../services/session/SessionLoggingService.html">SessionLoggingService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../services/sudo/SudoService.html">SudoService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../services/swagger/SwaggerService.html">SwaggerService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../services/tablecol/TableColumnOrderService.html">TableColumnOrderService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../services/title/TitleService.html">TitleService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../services/i18n/TranslationService.html">TranslationService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../services/i18n/TranslationsResolver.html">TranslationsResolver</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../services/xactn/TransactionalProcessor.html">TransactionProcessor</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../services/xactn/TransactionService.html">TransactionService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../services/urlencoding/UrlEncodingService.html">UrlEncodingService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../services/userprof/UserProfileService.html">UserProfileService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../services/userreg/UserRegistrationService.html">UserRegistrationService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../services/user/UserService.html">UserService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../services/wrapper/WrapperFactory.html">WrapperFactory</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../services/xml/XmlService.html">XmlService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../services/xmlsnapshot/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="../../../applib-ant/about.html">Annotations</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="Action.html">Action</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="ActionLayout.html">ActionLayout</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="Collection.html">Collection</a> |
| </li> |
| <li class="nav-item is-current-page" data-depth="2"> |
| <a class="nav-link" href="CollectionLayout.html">CollectionLayout</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../../applib-ant/Column.html">Column</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../../applib-ant/Digits.html">Digits</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../../applib-ant/Discriminator.html">Discriminator</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="DomainObject.html">DomainObject</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="DomainObjectLayout.html">DomainObjectLayout</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="DomainService.html">DomainService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="DomainServiceLayout.html">DomainServiceLayout</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="Facets.html">Facets</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="HomePage.html">HomePage</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="MemberOrder.html">MemberOrder</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../../applib-ant/NotPersistent.html">NotPersistent.</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../../applib-ant/Nullable.html">Nullable</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="MinLength.html">MinLength</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="Parameter.html">Parameter</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="ParameterLayout.html">ParameterLayout</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../../applib-ant/Pattern.html">Pattern</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../../applib-ant/PersistenceCapable.html">PersistenceCapable</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../../applib-ant/PrimaryKey.html">PrimaryKey</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="Programmatic.html">Programmatic</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="Property.html">Property</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="PropertyLayout.html">PropertyLayout</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="InteractionScope.html">RequestScoped</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="Title.html">Title</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../../applib-ant/XmlJavaTypeAdapter.html">XmlJavaTypeAdapter</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../../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="../../../applib-methods/about.html">Methods</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../../applib-methods/prefixes.html">Supporting Methods</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../../applib-methods/ui-hints.html">UI Hint Methods</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../../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"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../../../applib-classes/non-persisted-objects.html">Non-persisted objects</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../ViewModel.html">ViewModel</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../RecreatableDomainObject.html">RecreatableDomainObject</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../../applib-classes/layout.html">Layout</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../../../applib-classes/value-types.html">Value Types</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../value/Blob.html">Blob</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../value/Clob.html">Clob</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../value/Markup.html">Markup</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../value/LocalResourcePath.html">LocalResourcePath</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../value/Password.html">Password</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../../../applib-classes/utility.html">Utility Classes</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../util/Enums.html">Enums</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../util/JaxbUtil.html">JaxbUtil</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../util/ObjectContracts.html">ObjectContracts</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../util/Reasons.html">Reasons</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../util/ReasonBuffer.html">ReasonBuffer</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../util/ReasonBuffer2.html">ReasonBuffer2</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../util/TitleBuffer.html">TitleBuffer</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../../../applib-classes/mixees-and-mixins.html">Mixees and Mixins</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../mixins/layout/Object_downloadLayoutXml.html">Object_downloadLayoutXml</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../mixins/metamodel/Object_downloadMetamodelXml.html">Object_downloadMetamodelXml</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../mixins/metamodel/Object_rebuildMetamodel.html">Object_rebuildMetamodel</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../mixins/metamodel/Object_objectType.html">Object_objectType</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../mixins/metamodel/Object_objectIdentifier.html">Object_objectIdentifier</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../../viewer/index/wicket/viewer/mixins/Object_clearHints.html">Object_clearHints</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../mixins/rest/Object_openRestApi.html">Object_openRestApi</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../mixins/dto/Dto_downloadXml.html">Dto_downloadXml</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../mixins/dto/Dto_downloadXsd.html">Dto_downloadXsd</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../../persistence/index/jdo/datanucleus/mixins/Persistable_downloadJdoMetadata.html">Persistable_downloadJdoMetadata</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../../persistence/index/jdo/datanucleus/mixins/Persistable_datanucleusIdLong.html">Persistable_datanucleusIdLong</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../../persistence/index/jdo/datanucleus/mixins/Persistable_datanucleusVersionLong.html">Persistable_datanucleusVersionLong</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../../persistence/index/jdo/datanucleus/mixins/Persistable_datanucleusVersionTimestamp.html">Persistable_datanucleusVersionTimestamp</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../../extensions/index/commandlog/impl/mixins/HasInteractionId_command.html">HasInteractionId_command</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../mixins/system/DomainChangeRecord_openTargetObject.html">DomainChangeRecord_openTargetObject</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../../applib-classes/spec.html">Specification pattern</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../../../config/about.html">Configuration</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../../config/sections/isis.applib.html">Applib</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../../config/sections/isis.core.config.html">Core Configuration</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../../config/sections/isis.core.meta-model.html">Core MetaModel</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../../config/sections/isis.core.meta-model.introspector.html">Core MetaModel Introspection</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../../config/sections/isis.core.meta-model.validator.html">MetaModel Validator</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../../config/sections/isis.core.runtime.html">Core Runtime</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../../config/sections/isis.core.runtime-services.html">Core Runtime Services</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../../config/sections/isis.persistence.schema.html">Core Persistence Schema</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../../config/sections/isis.security.shiro.html">Shiro Security Implementation</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../../config/sections/isis.security.spring.html">Spring Security Implementation</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../../config/sections/datanucleus.html">DataNucleus</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../../config/sections/isis.viewer.restfulobjects.html">Restful Objects Viewer</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../../config/sections/isis.viewer.wicket.html">Wicket Viewer</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../../config/sections/isis.extensions.html">Extensions</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../../config/sections/isis.value-types.html">Value types</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../../config/sections/isis.testing.html">Testing</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../../config/sections/isis.legacy.html">Legacy</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../../config/sections/resteasy.html">RestEasy Configuration</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../../../schema/about.html">Schema</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../../schema/mml.html">MetaModel</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../../schema/cmd.html">Command</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../../schema/ixn.html">Interaction</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../../schema/chg.html">Changes</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../../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-M5</span> |
| </div> |
| <ul class="components"> |
| <li class="component"> |
| <span class="title"> </span> |
| <ul class="versions"> |
| <li class="version is-latest"> |
| <a href="../../../../../docs/2.0.0-M5/about.html">2.0.0-M5</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">BC Mapping Libraries</span> |
| <ul class="versions"> |
| <li class="version is-latest"> |
| <a href="../../../../../mappings/2.0.0-M5/about.html">2.0.0-M5</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Committers' Guide</span> |
| <ul class="versions"> |
| <li class="version is-latest"> |
| <a href="../../../../../comguide/2.0.0-M5/about.html">2.0.0-M5</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Contributors' Guide</span> |
| <ul class="versions"> |
| <li class="version is-latest"> |
| <a href="../../../../../conguide/2.0.0-M5/about.html">2.0.0-M5</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Design Docs</span> |
| <ul class="versions"> |
| <li class="version is-latest"> |
| <a href="../../../../../core/2.0.0-M5/about.html">2.0.0-M5</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Extensions Catalog</span> |
| <ul class="versions"> |
| <li class="version is-latest"> |
| <a href="../../../../../extensions/2.0.0-M5/about.html">2.0.0-M5</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Incubator Catalog</span> |
| <ul class="versions"> |
| <li class="version is-latest"> |
| <a href="../../../../../incubator/2.0.0-M5/about.html">2.0.0-M5</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">JDO/DataNucleus</span> |
| <ul class="versions"> |
| <li class="version is-latest"> |
| <a href="../../../../../pjdo/2.0.0-M5/about.html">2.0.0-M5</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">JPA</span> |
| <ul class="versions"> |
| <li class="version is-latest"> |
| <a href="../../../../../pjpa/2.0.0-M5/about.html">2.0.0-M5</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Legacy Catalog</span> |
| <ul class="versions"> |
| <li class="version is-latest"> |
| <a href="../../../../../legacy/2.0.0-M5/about.html">2.0.0-M5</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component is-current"> |
| <span class="title">Reference Guide</span> |
| <ul class="versions"> |
| <li class="version is-current is-latest"> |
| <a href="../../../about.html">2.0.0-M5</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Release Notes</span> |
| <ul class="versions"> |
| <li class="version is-latest"> |
| <a href="../../../../../relnotes/2.0.0-M5/about.html">2.0.0-M5</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">REST API (Restful Objects Viewer)</span> |
| <ul class="versions"> |
| <li class="version is-latest"> |
| <a href="../../../../../vro/2.0.0-M5/about.html">2.0.0-M5</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Security Guide</span> |
| <ul class="versions"> |
| <li class="version is-latest"> |
| <a href="../../../../../security/2.0.0-M5/about.html">2.0.0-M5</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Setup Guide</span> |
| <ul class="versions"> |
| <li class="version is-latest"> |
| <a href="../../../../../setupguide/2.0.0-M5/about.html">2.0.0-M5</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Subdomains Catalog</span> |
| <ul class="versions"> |
| <li class="version is-latest"> |
| <a href="../../../../../subdomains/2.0.0-M5/about.html">2.0.0-M5</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Testing Guide</span> |
| <ul class="versions"> |
| <li class="version is-latest"> |
| <a href="../../../../../testing/2.0.0-M5/about.html">2.0.0-M5</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Tooling</span> |
| <ul class="versions"> |
| <li class="version is-latest"> |
| <a href="../../../../../tooling/2.0.0-M5/about.html">2.0.0-M5</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">User Guide</span> |
| <ul class="versions"> |
| <li class="version is-latest"> |
| <a href="../../../../../userguide/2.0.0-M5/about.html">2.0.0-M5</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/2.0.0-M5/about.html">2.0.0-M5</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Web UI (Wicket Viewer)</span> |
| <ul class="versions"> |
| <li class="version is-latest"> |
| <a href="../../../../../vw/2.0.0-M5/about.html">2.0.0-M5</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/2.0.0-M5/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="../../../applib-ant/about.html">Annotations</a></li> |
| <li><a href="CollectionLayout.html">CollectionLayout</a></li> |
| </ul> |
| </nav> |
| <div class="edit-this-page"><a href="https://github.com/apache/isis/edit/2.0.0-M5/antora/components/refguide-index/modules/applib/pages/index/annotation/CollectionLayout.adoc">Edit</a></div> |
| </div> |
| <article class="doc"> |
| <a name="section-top"></a> |
| <h1 class="page">@CollectionLayout</h1> |
| <div id="preamble"> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>Layout hints for collections.</p> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="api"><a class="anchor" href="#api"></a>API</h2> |
| <div class="sectionbody"> |
| <div class="listingblock"> |
| <div class="title">CollectionLayout.java</div> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-java hljs" data-lang="java">@interface CollectionLayout { |
| String cssClass() default ""; <i class="conum" data-value="1"></i><b>(1)</b> |
| String defaultView() default ""; <i class="conum" data-value="2"></i><b>(2)</b> |
| String describedAs() default ""; <i class="conum" data-value="3"></i><b>(3)</b> |
| Where hidden() default Where.NOT_SPECIFIED; <i class="conum" data-value="4"></i><b>(4)</b> |
| String named() default ""; <i class="conum" data-value="5"></i><b>(5)</b> |
| boolean namedEscaped() default true; <i class="conum" data-value="6"></i><b>(6)</b> |
| int paged() default -1; <i class="conum" data-value="7"></i><b>(7)</b> |
| @SuppressWarnings("rawtypes") |
| Class sortedBy() default Comparator.class; <i class="conum" data-value="8"></i><b>(8)</b> |
| }</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="#cssClass">cssClass</a> |
| <div class="openblock"> |
| <div class="content"> |
| <div class="paragraph"> |
| <p>Indicates the css class that a collection should have, to allow more targeted styling in <code>application.css</code> .</p> |
| </div> |
| </div> |
| </div></td> |
| </tr> |
| <tr> |
| <td><i class="conum" data-value="2"></i><b>2</b></td> |
| <td><a href="#defaultView">defaultView</a> |
| <div class="openblock"> |
| <div class="content"> |
| <div class="paragraph"> |
| <p>Indicates which view is used by default to render the collection.</p> |
| </div> |
| </div> |
| </div></td> |
| </tr> |
| <tr> |
| <td><i class="conum" data-value="3"></i><b>3</b></td> |
| <td><a href="#describedAs">describedAs</a> |
| <div class="openblock"> |
| <div class="content"> |
| <div class="paragraph"> |
| <p>Description of this collection, eg to be rendered in a tooltip.</p> |
| </div> |
| </div> |
| </div></td> |
| </tr> |
| <tr> |
| <td><i class="conum" data-value="4"></i><b>4</b></td> |
| <td><a href="#hidden">hidden</a> |
| <div class="openblock"> |
| <div class="content"> |
| <div class="paragraph"> |
| <p>Indicates where in the UI the collection should <em>not</em> not be visible.</p> |
| </div> |
| </div> |
| </div></td> |
| </tr> |
| <tr> |
| <td><i class="conum" data-value="5"></i><b>5</b></td> |
| <td><a href="#named">named</a> |
| <div class="openblock"> |
| <div class="content"> |
| <div class="paragraph"> |
| <p>Name of this collection (overriding the name derived from its name in code).</p> |
| </div> |
| </div> |
| </div></td> |
| </tr> |
| <tr> |
| <td><i class="conum" data-value="6"></i><b>6</b></td> |
| <td><a href="#namedEscaped">namedEscaped</a> |
| <div class="openblock"> |
| <div class="content"> |
| <div class="paragraph"> |
| <p>A flag indicating whether the value of <em>#named()</em> should be HTML escaped or not.</p> |
| </div> |
| </div> |
| </div></td> |
| </tr> |
| <tr> |
| <td><i class="conum" data-value="7"></i><b>7</b></td> |
| <td><a href="#paged">paged</a> |
| <div class="openblock"> |
| <div class="content"> |
| <div class="paragraph"> |
| <p>The page size for instances of this class when rendered within a table.</p> |
| </div> |
| </div> |
| </div></td> |
| </tr> |
| <tr> |
| <td><i class="conum" data-value="8"></i><b>8</b></td> |
| <td><a href="#sortedBy">sortedBy</a> |
| <div class="openblock"> |
| <div class="content"> |
| <div class="paragraph"> |
| <p>Indicates that the elements in a ( <em>java.util.SortedSet</em> ) collection should be sorted according to a different order than the natural sort order, as defined by the specified <em>java.util.Comparator</em> .</p> |
| </div> |
| </div> |
| </div></td> |
| </tr> |
| </table> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="members"><a class="anchor" href="#members"></a>Members</h2> |
| <div class="sectionbody"> |
| <div class="sect2"> |
| <h3 id="cssClass"><a class="anchor" href="#cssClass"></a>cssClass</h3> |
| <div class="paragraph"> |
| <p>Indicates the css class that a collection should have, to allow more targeted styling in <code>application.css</code> .</p> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="defaultView"><a class="anchor" href="#defaultView"></a>defaultView</h3> |
| <div class="paragraph"> |
| <p>Indicates which view is used by default to render the collection.</p> |
| </div> |
| <div class="paragraph"> |
| <p>This is a simple string; every available implementation is required to use a different string.</p> |
| </div> |
| <div class="paragraph"> |
| <p>The default is "table". Extensions provide also: "excel" (download as Excel spreadsheet), "calendar" and "map".</p> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="describedAs"><a class="anchor" href="#describedAs"></a>describedAs</h3> |
| <div class="paragraph"> |
| <p>Description of this collection, eg to be rendered in a tooltip.</p> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="hidden"><a class="anchor" href="#hidden"></a>hidden</h3> |
| <div class="paragraph"> |
| <p>Indicates where in the UI the collection should <em>not</em> not be visible.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Only <em>Where#NOWHERE NOWHERE</em> or <em>Where#EVERYWHERE EVERYWHERE</em> / <em>Where#ANYWHERE ANYWHERE</em> apply for collections.</p> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="named"><a class="anchor" href="#named"></a>named</h3> |
| <div class="paragraph"> |
| <p>Name of this collection (overriding the name derived from its name in code).</p> |
| </div> |
| <div class="paragraph"> |
| <p>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> |
| </div> |
| <div class="sect2"> |
| <h3 id="namedEscaped"><a class="anchor" href="#namedEscaped"></a>namedEscaped</h3> |
| <div class="paragraph"> |
| <p>A flag indicating whether the value of <em>#named()</em> should be HTML escaped or not.</p> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="paged"><a class="anchor" href="#paged"></a>paged</h3> |
| <div class="paragraph"> |
| <p>The page size for instances of this class when rendered within a table.</p> |
| </div> |
| <div class="paragraph"> |
| <p>If annotated on a collection, then the page size refers to parented collections (eg <code>Order#lineItems</code> ).</p> |
| </div> |
| <div class="paragraph"> |
| <p>If annotated on a type, then the page size refers to standalone collections (eg as returned from a repository query).</p> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="sortedBy"><a class="anchor" href="#sortedBy"></a>sortedBy</h3> |
| <div class="paragraph"> |
| <p>Indicates that the elements in a ( <em>java.util.SortedSet</em> ) collection should be sorted according to a different order than the natural sort order, as defined by the specified <em>java.util.Comparator</em> .</p> |
| </div> |
| <div class="paragraph"> |
| <p>Whenever there is a collection of type <em>java.util.SortedSet</em> , the domain entity referenced is expected to implement <em>Comparable</em> , ie to have a natural ordering. In effect tis means that all domain entities should provide a natural ordering.</p> |
| </div> |
| <div class="paragraph"> |
| <p>However, in some circumstances the ordering of collection may be different to the entity’s natural ordering. For example, the entity may represent an interval of time sorted by its <em>startDate</em> ascending, but the collection may wish to sort by <em>startDate</em> .</p> |
| </div> |
| <div class="paragraph"> |
| <p>The purpose of this annotation is to provide a <em>java.util.Comparator</em> such that the collection may be sorted in an order more suitable to the context.</p> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="examples"><a class="anchor" href="#examples"></a>Examples</h2> |
| <div class="sectionbody"> |
| <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 { |
| @CollectionLayout( |
| cssClass="x-key", |
| named="Todo items that are <i>dependencies</i> of this item.", |
| namedEscaped=false, |
| describedAs="Other todo items that must be completed before this one", |
| labelPosition=LabelPosition.LEFT, |
| render=EAGERLY) |
| public SortedSet<ToDoItem> getDependencies() { /* ... */ } |
| ... |
| }</code></pre> |
| </div> |
| </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>@CollectionLayout</code> annotation, a <a href="../../../../../userguide/2.0.0-M5/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 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 annotation is one of a handful (others including <a href="Collection.html" class="page">@Collection</a>, <a href="Property.html" class="page">@Property</a> and <a href="PropertyLayout.html" class="page">@PropertyLayout</a>) that can also be applied to the field, rather than the getter method. |
| This is specifically so that boilerplate-busting tools such as <a href="https://projectlombok.org/">Project Lombok</a> can be used.</p> |
| </div> |
| </td> |
| </tr> |
| </table> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="usage-notes"><a class="anchor" href="#usage-notes"></a>Usage Notes</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>As alternative to using the annotation, the dynamic <a href="../../../../../userguide/2.0.0-M5/fun/ui.html#object-layout" class="page">file-based layout</a> can generally be used instead.</p> |
| </div> |
| <div class="sect2"> |
| <h3 id="default-view"><a class="anchor" href="#default-view"></a>Default view</h3> |
| <div class="paragraph"> |
| <p>The <a href="#defaultView">`defaultView()</a> element is used to select which of views should be used by default for a given collection. |
| Without any hint the collection is shown collapsed (to save real estate and reduce load time).</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 BusRoute { |
| |
| @CollectionLayout( defaultView="table" ) <i class="conum" data-value="1"></i><b>(1)</b> |
| @Getter @Setter |
| private SortedSet<BusStop> stops = ... |
| |
| }</code></pre> |
| </div> |
| </div> |
| <div class="colist arabic"> |
| <table> |
| <tr> |
| <td><i class="conum" data-value="1"></i><b>1</b></td> |
| <td>renders the collection as a table view.</td> |
| </tr> |
| </table> |
| </div> |
| <div class="paragraph"> |
| <p>The <a href="../../../../../vw/2.0.0-M5/about.html" class="page">Web UI (Wicket viewer)</a> allows additional views to be configured to render collections of objects, eg <a href="../../../../../vw/2.0.0-M5/exceldownload/about.html" class="page">Excel Download</a> ("excel"), <a href="../../../../../vw/2.0.0-M5/fullcalendar/about.html" class="page">Fullcalendar</a> ("fullcalendar") and <a href="../../../../../vw/2.0.0-M5/gmap3/about.html" class="page">Gmap3</a> ("map") extensions. |
| This attribute can be used to select any of these alternative views instead.</p> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="paging"><a class="anchor" href="#paging"></a>Paging</h3> |
| <div class="paragraph"> |
| <p>The <a href="#paged">paged()</a> element specifies the number of rows to display in a (parented) collection.</p> |
| </div> |
| <div class="admonitionblock warning"> |
| <table> |
| <tr> |
| <td class="icon"> |
| <i class="fa icon-warning" title="Warning"></i> |
| </td> |
| <td class="content"> |
| <div class="paragraph"> |
| <p>The <a href="../../../../../vro/2.0.0-M5/about.html" class="page">RestfulObjects viewer</a> currently does not support paging. |
| The <a href="../../../../../vw/2.0.0-M5/about.html" class="page">Web UI (Wicket viewer)</a> <em>does</em> support paging, but note that the paging is performed client-side rather than server-side.</p> |
| </div> |
| <div class="paragraph"> |
| <p>We therefore recommend that large collections should instead be modelled as actions (to allow filtering to be applied to limit the number of rows).</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">import lombok.Getter; |
| import lombok.Setter; |
| |
| public class Order { |
| |
| @CollectionLayout(paged=15) |
| @Getter @Setter |
| private SortedSet<OrderLine> details = ... |
| }</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>It is also possible to specify a global default for the page size of parented collections, using the <a href="../../../config/sections/isis.applib.html#isis.applib.annotation.collection-layout.paged" class="page">isis.applib.annotation.collection-layout.paged</a> configuration property.</p> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="descriptions"><a class="anchor" href="#descriptions"></a>Descriptions</h3> |
| <div class="paragraph"> |
| <p>The <a href="#describedAs">describedAs()</a> element is used to provide a short description of the collection to the user. |
| In the <a href="../../../../../vw/2.0.0-M5/about.html" class="page">Web UI (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">import lombok.Getter; |
| import lombok.Setter; |
| |
| public class ToDoItem { |
| |
| @CollectionLayout( |
| describedAs = "Todo items to be completed before this one" |
| ) |
| @Getter @Setter |
| private SortedSet<ToDoItem> dependencies = ... |
| |
| }</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="client-side-sorting"><a class="anchor" href="#client-side-sorting"></a>Client-side Sorting</h3> |
| <div class="paragraph"> |
| <p>The <a href="#sortedBy">sortedBy()</a> element specifies that the collection be ordered using the specified comparator, rather than the natural ordering of the entity (as would usually be the case).</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 ToDoItem implements Comparable<ToDoItem> { <i class="conum" data-value="1"></i><b>(1)</b> |
| |
| public static class DescriptionComparator <i class="conum" data-value="2"></i><b>(2)</b> |
| implements Comparator<ToDoItem> { |
| @Override |
| public int compare(ToDoItem o1, ToDoItem o2) { |
| return Comparator.comparing(ToDoItem::getDescription) |
| .compare(o1, o2); |
| } |
| } |
| |
| @CollectionLayout(sortedBy=DependenciesComparator.class) <i class="conum" data-value="3"></i><b>(3)</b> |
| @Getter @Setter |
| private SortedSet<ToDoItem> dependencies = ... |
| |
| }</code></pre> |
| </div> |
| </div> |
| <div class="colist arabic"> |
| <table> |
| <tr> |
| <td><i class="conum" data-value="1"></i><b>1</b></td> |
| <td>the class has a natural ordering (implementation not shown)</td> |
| </tr> |
| <tr> |
| <td><i class="conum" data-value="2"></i><b>2</b></td> |
| <td>declaration of an alternative comparator class, using the object’s <code>description</code> property</td> |
| </tr> |
| <tr> |
| <td><i class="conum" data-value="3"></i><b>3</b></td> |
| <td>ordering of the collection defined as being by this comparator</td> |
| </tr> |
| </table> |
| </div> |
| <div class="paragraph"> |
| <p>When the <code>dependencies</code> collection is rendered, the elements are sorted by the <code>description</code> property first.</p> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="css-styling"><a class="anchor" href="#css-styling"></a>CSS Styling</h3> |
| <div class="paragraph"> |
| <p>The <a href="#cssClass">cssClass()</a> element can be used to render additional CSS classes in the HTML (a wrapping <code><div></code>) that represents the collection. |
| <a href="../../../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">import lombok.Getter; |
| import lombok.Setter; |
| |
| public class ToDoItem { |
| |
| @CollectionLayout( |
| cssClass="x-important" |
| ) |
| @Getter @Setter |
| private SortedSet<ToDoItem> dependencies = ...; |
| |
| }</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="names"><a class="anchor" href="#names"></a>Names</h3> |
| <div class="paragraph"> |
| <p>The <a href="#named">named()</a> element explicitly specifies the collection’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>We recommend that you only use this element 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>By default the name is HTML escaped. |
| To allow HTML markup, set the related <a href="#namedEscaped">namedEscaped()</a> element to <code>false</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 ToDoItem { |
| @CollectionLayout( |
| named="Todo items that are <i>dependencies</i> of this item", |
| namedEscaped=false |
| ) |
| @Getter @Setter |
| private SortedSet<ToDoItem> dependencies = ... |
| |
| }</code></pre> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="alternatives"><a class="anchor" href="#alternatives"></a>Alternatives</h4> |
| <div class="paragraph"> |
| <p>The framework also provides a separate, powerful mechanism for <a href="../../../../../userguide/2.0.0-M5/btb/i18n.html" class="page">internationalization</a>.</p> |
| </div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="hiding-collections"><a class="anchor" href="#hiding-collections"></a>Hiding collections</h3> |
| <div class="paragraph"> |
| <p>The <a href="#hidden">hidden()</a> element indicates where (in the UI) the collection should be hidden from the user.</p> |
| </div> |
| <div class="paragraph"> |
| <p>The acceptable values are:</p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><code>Where.EVERYWHERE</code> or <code>Where.ANYWHERE</code></p> |
| <div class="paragraph"> |
| <p>The collection should be hidden everywhere.</p> |
| </div> |
| </li> |
| <li> |
| <p><code>Where.ANYWHERE</code></p> |
| <div class="paragraph"> |
| <p>Synonym for everywhere.</p> |
| </div> |
| </li> |
| <li> |
| <p><code>Where.OBJECT_FORMS</code></p> |
| <div class="paragraph"> |
| <p>The collection should be hidden when displayed within an object form.</p> |
| </div> |
| </li> |
| <li> |
| <p><code>Where.NOWHERE</code></p> |
| <div class="paragraph"> |
| <p>The collection 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="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 ToDoItem { |
| |
| @CollectionLayout( |
| hidden=Where.EVERYWHERE |
| ) |
| @Getter @Setter |
| private SortedSet<ToDoItem> dependencies = ... |
| }</code></pre> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="alternatives-2"><a class="anchor" href="#alternatives-2"></a>Alternatives</h4> |
| <div class="paragraph"> |
| <p>It is also possible to use <a href="Collection.html#hidden" class="page">@Collection#hidden</a> to hide a collection at the domain layer.</p> |
| </div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </article> |
| <aside class="article-aside toc hide-for-print" 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~2021 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: 2.0.0-M5.20210409-1206</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> |
| |
| <script src="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js"></script> |
| <script> |
| function focusSearchInput () { document.querySelector('#algolia-search-input').focus() } |
| var search = docsearch({ |
| appId: '5ISP5TFAEN', |
| apiKey: '0fc51c28b4ad46e7318e96d4e97fab7c', |
| indexName: 'isis-apache-org', |
| inputSelector: '#algolia-search-input', |
| autocompleteOptions: { hint: false, keyboardShortcuts: ['s'] }, |
| debug: false, |
| }).autocomplete |
| search.on('autocomplete:closed', function () { search.autocomplete.setVal() }) |
| focusSearchInput() |
| window.addEventListener('load', focusSearchInput); |
| </script> |
| |
| <!-- |
| docsearch options: |
| https://docsearch.algolia.com/docs/behavior/ |
| --> |
| <!-- |
| https://www.algolia.com/doc/api-reference/api-parameters/ |
| algoliaOptions: { hitsPerPage: 6 }, |
| --> |
| </body> |
| </html> |
