[#ui-layout-hints]
= UI Layout & Hints

:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR  CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
:page-partial:


In implementing the http://en.wikipedia.org/wiki/Naked_objects[naked objects pattern], Apache Causeway infers as much information from the domain classes as possible.
Nevertheless, some metadata relating solely to the UI is inevitably required.

The Apache Causeway programming model includes several mechanisms to influence the way in which the domain objects are rendered in the UI.

* the layout of application menu items (inferred from xref:domain-entities-and-services.adoc#domain-services[domain services])

* the layout of domain objects (xref:domain-entities-and-services.adoc#domain-entities[domain entities] and xref:view-models.adoc[view models]) allow the positioning of the xref:object-members.adoc[object members] into columns and tabs

* UI hints provided by the domain object itself returning:

** the title so the end-user can distinguish one object from another
** an icon to indicate the type of object (and perhaps its state)
** CSS styles for additional adhoc styling
** an alternate layout, for example changed according to the roles of the end-user that is viewing it.

* in collections, how to customise which properties of the associated object appear as columns.

This chapter discusses these topics.


include::ui/names-and-descriptions.adoc[leveloffset=+1]
include::ui/object-titles-and-icons.adoc[leveloffset=+1]
include::ui/action-icons-and-css.adoc[leveloffset=+1]

include::ui/menubars-layout.adoc[leveloffset=+1]
include::ui/object-layout.adoc[leveloffset=+1]

include::ui/table-columns.adoc[leveloffset=+1]
