public abstract class PropertyDescriptorBuilder<TBuilder extends PropertyDescriptorBuilder<TBuilder>>
extends Object
property descriptor
builders.
Property descriptors
can be instantiated using extensions of this class, for example, BooleanPropertyDescriptor.BooleanPropertyDescriptorBuilder
.
Modifier and Type | Field and Description |
---|---|
protected List<Choice> |
choices |
protected Map<String,Object> |
data |
Modifier | Constructor and Description |
---|---|
protected |
PropertyDescriptorBuilder() |
Modifier and Type | Method and Description |
---|---|
abstract PropertyDescriptor |
build()
Constructs the built property descriptor.
|
protected void |
checkValidState() |
TBuilder |
description(String description)
Sets text to display in a help icon as a tooltip.
|
TBuilder |
displayHint(DisplayHint displayHint)
Determines whether the UI component appears as a standard input field.
|
TBuilder |
instructionText(String instructionText)
Sets optional text displayed below the component's value.
|
TBuilder |
isExpressionable(boolean isExpressionable)
Determines if field can be entered as an expression.
|
TBuilder |
isHidden(boolean isHidden)
Determines whether the field is displayed in the UI.
|
TBuilder |
isImportCustomizable(boolean isImportCustomizable)
Determines whether this value should be changed between environments.
|
TBuilder |
isReadOnly(boolean isReadOnly)
Determines whether the property's value is editable by the user.
|
TBuilder |
isRequired(boolean isRequired)
Determines whether a non-null value is required to submit the form.
|
TBuilder |
key(String key)
Sets the unique identifier for this property.
|
TBuilder |
label(String label)
Sets optional text to display at the top of this component.
|
TBuilder |
placeholder(String placeholder)
Sets optional text to display in the component when it is empty.
|
TBuilder |
refresh(RefreshPolicy refresh)
Determines whether changes to this property's UI component will refresh the
configuration descriptor . |
protected TBuilder |
type(SystemType type) |
protected TBuilder |
type(TypeReference typeRef) |
protected Map<String,Object> data
protected List<Choice> choices
public TBuilder key(String key)
public TBuilder label(String label)
In the case of the BooleanPropertyDescriptor
BooleanDisplayMode.CHECKBOX
display mode, the label appears next to the checkbox.
public TBuilder description(String description)
public TBuilder instructionText(String instructionText)
public TBuilder placeholder(String placeholder)
protected TBuilder type(TypeReference typeRef)
protected TBuilder type(SystemType type)
public TBuilder refresh(RefreshPolicy refresh)
configuration descriptor
. The configuration descriptor
is refreshed by calling either IntegrationTemplate.getConfigurationDescriptor(ConfigurationDescriptor, ConfigurationDescriptor, PropertyPath, ExecutionContext)
or IntegrationTemplate.getConfigurationDescriptor(ConfigurationDescriptor, ConfigurationDescriptor, PropertyPath, ExecutionContext)
.
See also, RefreshPolicy
Default: RefreshPolicy.NEVER
public TBuilder displayHint(DisplayHint displayHint)
DisplayHint.NORMAL
display hint can still be expressionable
.
See also, DisplayHint
Default: DisplayHint.NORMAL
public TBuilder isRequired(boolean isRequired)
Default: false
.
public TBuilder isExpressionable(boolean isExpressionable)
true
. To make the property always appear as an expression box, use the display hint
.
Default: false
public TBuilder isReadOnly(boolean isReadOnly)
Default: false
.
public TBuilder isHidden(boolean isHidden)
Use hidden fields to store internal values needed for execution that cannot be acquired efficiently at execution time.
Default: false
public TBuilder isImportCustomizable(boolean isImportCustomizable)
true
.
Default: false
public abstract PropertyDescriptor build()
protected void checkValidState()
Copyright © 2018-present Appian Corporation. All Rights Reserved.