Module org.mule.runtime.extensions.api

Package org.mule.runtime.extension.api.declaration.type.annotation

Class LayoutTypeAnnotation

java.lang.Object

org.mule.runtime.extension.api.declaration.type.annotation.LayoutTypeAnnotation

All Implemented Interfaces:

org.mule.metadata.api.annotation.TypeAnnotation

public class LayoutTypeAnnotation
extends Object
implements org.mule.metadata.api.annotation.TypeAnnotation

A TypeAnnotation meant to be applied on ObjectFieldType instances and it contains information on how the field should be rendered in the UI. That information is obtained through the Text, Password and Placement annotations.

Since:

1.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

Constructor Summary

Constructors

Constructor	Description
LayoutTypeAnnotation(org.mule.runtime.api.meta.model.display.LayoutModel layoutModel)	Creates a new instance

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
org.mule.runtime.api.meta.model.display.LayoutModel	getLayoutModel()
String	getName()
Optional<Integer>	getOrder()
Optional<String>	getTabName()
int	hashCode()
boolean	isPassword()
boolean	isQuery()
boolean	isText()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.mule.metadata.api.annotation.TypeAnnotation

isPublic

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

LayoutTypeAnnotation

public LayoutTypeAnnotation(org.mule.runtime.api.meta.model.display.LayoutModel layoutModel)

Creates a new instance

Parameters:

layoutModel - a LayoutModel

Method Details

getName

public String getName()

Specified by:

getName in interface org.mule.metadata.api.annotation.TypeAnnotation

isPassword

public boolean isPassword()

Returns:

Whether the underlying model represents a password and should be masked in the UI

isText

public boolean isText()

Returns:

Whether the underlying model should be edited with a multi line string editor in the UI

isQuery

public boolean isQuery()

Returns:

Whether the underlying model represents a query and should be treated accordingly in the UI

getOrder

public Optional<Integer> getOrder()

Returns:

The order of the model within its group.

getTabName

public Optional<String> getTabName()

Returns:

The tab element name where the model and its group it's going to be located.

getLayoutModel

public org.mule.runtime.api.meta.model.display.LayoutModel getLayoutModel()

Returns:

The underlying LayoutModel that this TypeAnnotation represents.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object