= ActionLayoutData
: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.

Describes the layout of a single action, broadly corresponding to _org.apache.causeway.applib.annotation.ActionLayout_ .

== API

[source,java]
.ActionLayoutData.java
----
class ActionLayoutData {
  ActionLayoutData()
  ActionLayoutData(String id)
  String getId()     // <.>
  void setId(String id)
  String getCssClass()
  void setCssClass(String cssClass)
  String getCssClassFa()
  void setCssClassFa(String cssClassFa)
  CssClassFaPosition getCssClassFaPosition()
  void setCssClassFaPosition(CssClassFaPosition cssClassFaPosition)
  String getDescribedAs()
  void setDescribedAs(String describedAs)
  Where getHidden()
  void setHidden(Where hidden)
  String getNamed()
  void setNamed(String named)
  org.apache.causeway.applib.annotation.ActionLayout.Position getPosition()
  void setPosition(org.apache.causeway.applib.annotation.ActionLayout.Position position)
  PromptStyle getPromptStyle()
  void setPromptStyle(PromptStyle promptStyle)
  Redirect getRedirect()
  void setRedirect(Redirect redirect)
  ActionLayoutDataOwner getOwner()     // <.>
  void setOwner(ActionLayoutDataOwner owner)
  String getMetadataError()     // <.>
  void setMetadataError(String metadataError)
  Link getLink()     // <.>
  void setLink(Link link)
  String toString()
}
----

<.> xref:#getId_[getId()]
+
--
Method name.
--
<.> xref:#getOwner_[getOwner()]
+
--
Owner.
--
<.> xref:#getMetadataError_[getMetadataError()]
+
--
For diagnostics; populated by the framework if and only if a metadata error.
--
<.> xref:#getLink_[getLink()]
+
--
The link to access this resource from the REST API (Restful Objects viewer).
--

== Members

[#getId_]
=== getId()

Method name.

Overloaded methods are not supported.

[#getOwner_]
=== getOwner()

Owner.

Set programmatically by framework after reading in from XML.

[#getMetadataError_]
=== getMetadataError()

For diagnostics; populated by the framework if and only if a metadata error.

[#getLink_]
=== getLink()

The link to access this resource from the REST API (Restful Objects viewer).

Populated by the framework automatically.
