= @DomainServiceLayout
: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.

Layout hints for domain services.

Also indicates the name, and menu ordering UI hints.

== API

[source,java]
.DomainServiceLayout.java
----
@interface DomainServiceLayout {
  MenuBar menuBar() default MenuBar.NOT_SPECIFIED;     // <.>
  String named() default "";     // <.>
}
----

<.> xref:#menuBar[menuBar]
+
--
The menubar in which the menu that holds this service's actions should reside.
--
<.> xref:#named[named]
+
--
Name of this class (overriding the name derived from its name in code).
--

== Members

[#menuBar]
=== menuBar

The menubar in which the menu that holds this service's actions should reside.

[#named]
=== named

Name of this class (overriding the name derived from its name in code).

A typical use case is if the desired name is a reserved Java keyword, such as `default` or `package`.

include::hooks/DomainServiceLayout_010-examples-and-usage.adoc[]

include::hooks/DomainServiceLayout_021-menuBar.adoc[]

include::hooks/DomainServiceLayout_022-named.adoc[]
