public abstract class PropertyDescriptor<T extends PropertyDescriptorBuilder>
extends Object
Each PropertyDescriptor implementation can have specific configurations for its UI field
Modifier and Type | Field and Description |
---|---|
static String |
CHOICES |
protected Map<String,Object> |
data |
static String |
DESCRIPTION |
static String |
DISPLAY_HINT |
static String |
INSTRUCTION_TEXT |
static String |
IS_EXPRESSIONABLE |
static String |
IS_HIDDEN |
static String |
IS_IMPORT_CUSTOMIZABLE |
static String |
IS_READ_ONLY |
static String |
IS_REQUIRED |
static String |
KEY |
static String |
LABEL |
static String |
PLACEHOLDER |
static String |
REFRESH |
static String |
TYPE_NAME |
Modifier and Type | Method and Description |
---|---|
protected abstract PropertyDescriptorBuilder |
getBuilder() |
String |
getDescription()
Text displayed as a tooltip.
|
DisplayHint |
getDisplayHint()
Default:
DisplayHint.NORMAL
Whether UI component is displayed as an expression box or a standard input field |
String |
getInstructionText()
Text displayed below the field's value
|
String |
getKey()
Unique identifier for this property.
|
String |
getLabel()
Text to display as the field label
|
String |
getPlaceholder()
Text to display in the component when it is empty.
|
RefreshPolicy |
getRefresh()
Default:
RefreshPolicy.NEVER
Determines when changes to the UI component will trigger refresh |
TypeReference |
getTypeRef() |
boolean |
isExpressionable()
Default:
false
Whether the field can be entered as an expression
If dynamic behavior will be defined by the designer set this to true
To make the property always appear as an expression box, use the display hint . |
boolean |
isHidden()
Default:
false
Whether the field is displayed in the UI. |
boolean |
isImportCustomizable()
Default:
false
Whether this value should be changed between environments. |
boolean |
isReadOnly()
Default:
false
Determines whether the property's value is editable by the user. |
boolean |
isRequired()
Default:
false
Whether the field is required |
String |
toString() |
<R extends PropertyDescriptor<? extends PropertyDescriptorBuilder>> |
update(Function<T,T> update)
Updates individual fields of the property descriptor
|
public static final String KEY
public static final String LABEL
public static final String DESCRIPTION
public static final String INSTRUCTION_TEXT
public static final String PLACEHOLDER
public static final String TYPE_NAME
public static final String REFRESH
public static final String IS_REQUIRED
public static final String IS_READ_ONLY
public static final String IS_HIDDEN
public static final String IS_EXPRESSIONABLE
public static final String IS_IMPORT_CUSTOMIZABLE
public static final String CHOICES
public static final String DISPLAY_HINT
protected Map<String,Object> data
public String getKey()
public String getLabel()
public String getDescription()
public String getInstructionText()
public String getPlaceholder()
public TypeReference getTypeRef()
public RefreshPolicy getRefresh()
RefreshPolicy.NEVER
Determines when changes to the UI component will trigger refreshpublic DisplayHint getDisplayHint()
DisplayHint.NORMAL
Whether UI component is displayed as an expression box or a standard input fieldpublic boolean isRequired()
false
Whether the field is requiredpublic boolean isExpressionable()
false
Whether the field can be entered as an expression
If dynamic behavior will be defined by the designer set this to true
To make the property always appear as an expression box, use the display hint
.
public boolean isReadOnly()
false
Determines whether the property's value is editable by the user. Read only fields can be used to provide the user with additional context or information.public boolean isHidden()
Default: false
Use hidden fields to store internal values needed for execution that cannot be acquired efficiently at execution time.
public boolean isImportCustomizable()
Default: false
true
.public <R extends PropertyDescriptor<? extends PropertyDescriptorBuilder>> R update(Function<T,T> update)
R
- Subtype of property descriptorupdate
- Applies updates to the PropertyDescriptorpublic String toString()
toString
in class Object
protected abstract PropertyDescriptorBuilder getBuilder()
Copyright © 2018-present Appian Corporation. All Rights Reserved.