Package de.xima.fc.interfaces.workflow.value

Class StandardValueDescriptorAttributes

java.lang.Object

de.xima.fc.interfaces.workflow.value.StandardValueDescriptorAttributes

public final class StandardValueDescriptorAttributes
extends Object

Standard attribute for value and file descriptor attributes, IValueDescriptor.getAttributes() and IFileListDescriptor.getAttributes().

Since:

8.5.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StandardValueDescriptorAttributes.ValueDescriptorAttributeContentType	Standard values for message content attributes, such as VALUE_DESCRIPTOR_ATTR_LABEL_CONTENT.
static class	StandardValueDescriptorAttributes.ValueDescriptorAttributeMessageType	Standard values for message type attributes, such as VALUE_DESCRIPTOR_ATTR_LABEL_TYPE.
static class	StandardValueDescriptorAttributes.ValueDescriptorAttributeUiType	Standard values for the VALUE_DESCRIPTOR_ATTR_UI_TYPE attribute.

Field Summary

Fields

Modifier and Type	Field	Description
static String	VALUE_DESCRIPTOR_ATTR_DESCRIPTION	(type: String).
static String	VALUE_DESCRIPTOR_ATTR_DESCRIPTION_CONTENT	(type: String, one of StandardValueDescriptorAttributes.ValueDescriptorAttributeContentType).
static String	VALUE_DESCRIPTOR_ATTR_DESCRIPTION_PARAMETERS	(type: Object[]).
static String	VALUE_DESCRIPTOR_ATTR_DESCRIPTION_TYPE	(type: String, one of StandardValueDescriptorAttributes.ValueDescriptorAttributeMessageType).
static String	VALUE_DESCRIPTOR_ATTR_DISCRIMINATOR_LABEL	(type: String).
static String	VALUE_DESCRIPTOR_ATTR_DISCRIMINATOR_LABEL_PARAMETERS	(type: Object[]).
static String	VALUE_DESCRIPTOR_ATTR_DISCRIMINATOR_LABEL_TYPE	(type: String, one of StandardValueDescriptorAttributes.ValueDescriptorAttributeMessageType).
static String	VALUE_DESCRIPTOR_ATTR_LABEL	(type: String).
static String	VALUE_DESCRIPTOR_ATTR_LABEL_CONTENT	(type: String, one of StandardValueDescriptorAttributes.ValueDescriptorAttributeContentType).
static String	VALUE_DESCRIPTOR_ATTR_LABEL_PARAMETERS	(type: Object[]).
static String	VALUE_DESCRIPTOR_ATTR_LABEL_TYPE	(type: String, one of StandardValueDescriptorAttributes.ValueDescriptorAttributeMessageType).
static String	VALUE_DESCRIPTOR_ATTR_LOCALIZER	(type: IMessageLocalizer or IBoundMessageLocalizer).
static String	VALUE_DESCRIPTOR_ATTR_UI_TYPE	(type: String, one of StandardValueDescriptorAttributes.ValueDescriptorAttributeUiType).
static String	VALUE_DESCRIPTOR_FC_PLACEHOLDER	(type: Boolean).

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

VALUE_DESCRIPTOR_ATTR_DESCRIPTION

public static final String VALUE_DESCRIPTOR_ATTR_DESCRIPTION

(type: String).

Key for the description of the value. This label can be used in UIs to provide even more detailed information about the value to users, in addition to the label. It can be either a localized message or an I18N key that will be resolved at runtime.

See Also:

VALUE_DESCRIPTOR_ATTR_DESCRIPTION_TYPE, Constant Field Values

VALUE_DESCRIPTOR_ATTR_DESCRIPTION_PARAMETERS

public static final String VALUE_DESCRIPTOR_ATTR_DESCRIPTION_PARAMETERS

(type: Object[]).

Key for the message parameters of the description. Can be used to interpolate the message when the description type is set to message key. Inside the message, the first parameter can be accessed via {0}, the second via {1}, and so on.

See Also:

VALUE_DESCRIPTOR_ATTR_DESCRIPTION, Constant Field Values

VALUE_DESCRIPTOR_ATTR_DESCRIPTION_CONTENT

public static final String VALUE_DESCRIPTOR_ATTR_DESCRIPTION_CONTENT

(type: String, one of StandardValueDescriptorAttributes.ValueDescriptorAttributeContentType).

Key for the content of the descriptions of the value. Controls whether the description is plain text or HTML.

See Also:

StandardValueDescriptorAttributes.ValueDescriptorAttributeMessageType, Constant Field Values

VALUE_DESCRIPTOR_ATTR_DESCRIPTION_TYPE

public static final String VALUE_DESCRIPTOR_ATTR_DESCRIPTION_TYPE

(type: String, one of StandardValueDescriptorAttributes.ValueDescriptorAttributeMessageType).

Key for the type of the descriptions of the value. Controls how the description should be interpreted, either literally or as a message key. Default depends on the context where the value descriptor is used.

See Also:

StandardValueDescriptorAttributes.ValueDescriptorAttributeMessageType, Constant Field Values

VALUE_DESCRIPTOR_ATTR_DISCRIMINATOR_LABEL

public static final String VALUE_DESCRIPTOR_ATTR_DISCRIMINATOR_LABEL

(type: String).

Key for the discriminator label of the value, applicable to the children of union value descriptors. The display name of the discriminator value. It can be either a localized message or an I18N key that will be resolved at runtime.

See Also:

VALUE_DESCRIPTOR_ATTR_DISCRIMINATOR_LABEL_TYPE, Constant Field Values

VALUE_DESCRIPTOR_ATTR_DISCRIMINATOR_LABEL_PARAMETERS

public static final String VALUE_DESCRIPTOR_ATTR_DISCRIMINATOR_LABEL_PARAMETERS

(type: Object[]).

Key for the message parameters of the discriminator label. Can be used to interpolate the message when the label type is set to message key. Inside the message, the first parameter can be accessed via {0}, the second via {1} , and so on.

See Also:

VALUE_DESCRIPTOR_ATTR_DISCRIMINATOR_LABEL, Constant Field Values

VALUE_DESCRIPTOR_ATTR_DISCRIMINATOR_LABEL_TYPE

public static final String VALUE_DESCRIPTOR_ATTR_DISCRIMINATOR_LABEL_TYPE

(type: String, one of StandardValueDescriptorAttributes.ValueDescriptorAttributeMessageType).

Key for the type of the discriminator label of the value. Controls how the label should be interpreted, either literally or as a message key. Default depends on the context where the value descriptor is used.

See Also:

StandardValueDescriptorAttributes.ValueDescriptorAttributeMessageType, Constant Field Values

VALUE_DESCRIPTOR_ATTR_LABEL

public static final String VALUE_DESCRIPTOR_ATTR_LABEL

(type: String).

Key for the label of the value. This label can be used in UIs to provide additional information about the value to users. It can be either a localized message or an I18N key that will be resolved at runtime.

See Also:

VALUE_DESCRIPTOR_ATTR_LABEL_TYPE, Constant Field Values

VALUE_DESCRIPTOR_ATTR_LABEL_CONTENT

public static final String VALUE_DESCRIPTOR_ATTR_LABEL_CONTENT

(type: String, one of StandardValueDescriptorAttributes.ValueDescriptorAttributeContentType).

Key for the content of the descriptions of the value. Controls whether the label is plain text or HTML.

See Also:

StandardValueDescriptorAttributes.ValueDescriptorAttributeMessageType, Constant Field Values

VALUE_DESCRIPTOR_ATTR_LABEL_PARAMETERS

public static final String VALUE_DESCRIPTOR_ATTR_LABEL_PARAMETERS

(type: Object[]).

Key for the message parameters of the label. Can be used to interpolate the message when the label type is set to message key. Inside the message, the first parameter can be accessed via {0}, the second via {1}, and so on.

See Also:

VALUE_DESCRIPTOR_ATTR_LABEL, Constant Field Values

VALUE_DESCRIPTOR_ATTR_LABEL_TYPE

public static final String VALUE_DESCRIPTOR_ATTR_LABEL_TYPE

(type: String, one of StandardValueDescriptorAttributes.ValueDescriptorAttributeMessageType).

Key for the type of the label of the value. Controls how the label should be interpreted, either literally or as a message key. Default depends on the context where the value descriptor is used.

See Also:

StandardValueDescriptorAttributes.ValueDescriptorAttributeMessageType, Constant Field Values

VALUE_DESCRIPTOR_ATTR_LOCALIZER

public static final String VALUE_DESCRIPTOR_ATTR_LOCALIZER

(type: IMessageLocalizer or IBoundMessageLocalizer).

Key for the localizer to use for localizing messages such as VALUE_DESCRIPTOR_ATTR_LABEL and VALUE_DESCRIPTOR_ATTR_DESCRIPTION. This is an override, if not given, a default is used. Once set, the localizer inherits to all child value descriptors.

See Also:

Constant Field Values

VALUE_DESCRIPTOR_ATTR_UI_TYPE

public static final String VALUE_DESCRIPTOR_ATTR_UI_TYPE

(type: String, one of StandardValueDescriptorAttributes.ValueDescriptorAttributeUiType).

Key for the UI type hint. When generating a user interface for editing or displaying the value, this hint can be used to determine the appropriate control or widget to use.

See Also:

StandardValueDescriptorAttributes.ValueDescriptorAttributeUiType, Constant Field Values

VALUE_DESCRIPTOR_FC_PLACEHOLDER

public static final String VALUE_DESCRIPTOR_FC_PLACEHOLDER

(type: Boolean).

Key for whether the value allows formcycle placeholders such as [%tf1%].

See Also:

Constant Field Values