org.mule.runtime.extension.api.introspection.property

Class LayoutModelProperty

java.lang.Object

org.mule.runtime.extension.api.introspection.property.LayoutModelProperty

All Implemented Interfaces:

Serializable, ModelProperty, Named

public final class LayoutModelProperty
extends Object
implements ModelProperty

Provides UI related properties for a ParameterModel

Since:

1.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LayoutModelProperty(boolean password, boolean text, int order, String groupName, String tabName)

Method Summary

Modifier and Type	Method and Description
String	getGroupName()
String	getName() A unique name which identifies this property.
int	getOrder()
String	getTabName()
boolean	isExternalizable() Whether this instance should be included when serializing or sharing the owning EnrichableModel or if on the contrary, this model property holds information which is proprietary to the runtime and should not communicated.
boolean	isPassword()
boolean	isText()

Methods inherited from class java.lang.Object

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

Constructor Detail

LayoutModelProperty

public LayoutModelProperty(boolean password,
                           boolean text,
                           int order,
                           String groupName,
                           String tabName)

Method Detail

getName

public String getName()

A unique name which identifies this property. No model should contain two instances with the same name

Specified by:

getName in interface ModelProperty

Specified by:

getName in interface Named

Returns:

Display properties

isExternalizable

public boolean isExternalizable()

Whether this instance should be included when serializing or sharing the owning EnrichableModel or if on the contrary, this model property holds information which is proprietary to the runtime and should not communicated.

Non externalizable properties should be skipped by serializers and any other kind of sharing mechanisms.

Specified by:

isExternalizable in interface ModelProperty

Returns:

true

isPassword

public boolean isPassword()

Returns:

Whether the field should be masked in the UI or not

isText

public boolean isText()

Returns:

Whether the field should use a multi line string editor in the UI or not

getOrder

public int getOrder()

Returns:

The order of the parameter within its group.

getGroupName

public String getGroupName()

Returns:

The group element name where the parameter is going to be located.

getTabName

public String getTabName()

Returns:

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