com.pingidentity.pa.sdk.ui

Annotation Type UIElement

@Target(value=FIELD)
 @Retention(value=RUNTIME)
public @interface UIElement

Annotation to be applied to Fields. It is used in conjunction with ConfigurationBuilder.from(Class)

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	label Sets the ConfigurationField.setLabel(String)
int	order Determines field order in the UI and the order in which ConfigurationFields are added to a ConfigurationBuilder
ConfigurationType	type Sets the ConfigurationField.setType(ConfigurationType)

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	advanced Sets the ConfigurationField.setAdvanced(boolean)
String	buttonGroup Sets ConfigurationField.setButtonGroup(String) when a ConfigurationField is of type ConfigurationType.RADIO_BUTTON Default: "default"
String	defaultValue Sets the ConfigurationField.setDefaultValue(String)
boolean	deselectable Sets ConfigurationField.setDeselectable(boolean) when a ConfigurationField is of type ConfigurationType.RADIO_BUTTON Default: false
Help	help Sets the ConfigurationField.setHelp(com.pingidentity.pa.sdk.ui.ConfigurationField.Help)
Class<? extends ConfigurationModelAccessor>	modelAccessor Sets the DynamicOptionsConfigurationField.getModelAccessorClass()
Option[]	options Sets the ConfigurationField.setOptions(java.util.Collection)
ParentField	parentField Sets ConfigurationField.setParentField(ConfigurationParentField) Default: an empty parent field
boolean	required Sets the ConfigurationField.setRequired(boolean)
Class<?>	subFieldClass Defines the expected class when a ConfigurationField is of type ConfigurationType.TABLE.

Element Detail

order

public abstract int order

Determines field order in the UI and the order in which ConfigurationFields are added to a ConfigurationBuilder

Returns:

the order

type

public abstract ConfigurationType type

Sets the ConfigurationField.setType(ConfigurationType)

Returns:

the ConfigurationType

label

public abstract String label

Sets the ConfigurationField.setLabel(String)

Returns:

the label

defaultValue

public abstract String defaultValue

Sets the ConfigurationField.setDefaultValue(String)

Returns:

the default value

Default:

""

advanced

public abstract boolean advanced

Sets the ConfigurationField.setAdvanced(boolean)

Returns:

true if advanced

Default:

false

required

public abstract boolean required

Sets the ConfigurationField.setRequired(boolean)

Returns:

true if required

Default:

false

options

public abstract Option[] options

Sets the ConfigurationField.setOptions(java.util.Collection)

Returns:

the array of Options

Default:

{}

help

public abstract Help help

Sets the ConfigurationField.setHelp(com.pingidentity.pa.sdk.ui.ConfigurationField.Help)

Returns:

the Help

Default:

@com.pingidentity.pa.sdk.ui.Help

subFieldClass

public abstract Class<?> subFieldClass

Defines the expected class when a ConfigurationField is of type ConfigurationType.TABLE.

Returns:

the subfield class

Default:

com.pingidentity.pa.sdk.ui.UIElement.NONE.class

buttonGroup

public abstract String buttonGroup

Sets ConfigurationField.setButtonGroup(String) when a ConfigurationField is of type ConfigurationType.RADIO_BUTTON

Default: "default"

Returns:

the button group

Default:

"default"

deselectable

public abstract boolean deselectable

Sets ConfigurationField.setDeselectable(boolean) when a ConfigurationField is of type ConfigurationType.RADIO_BUTTON

Default: false

Returns:

true if deselectable

Default:

false

modelAccessor

public abstract Class<? extends ConfigurationModelAccessor> modelAccessor

Sets the DynamicOptionsConfigurationField.getModelAccessorClass()

Returns:

the model accessor class

Default:

com.pingidentity.pa.sdk.ui.UIElement.NONE.class

parentField

public abstract ParentField parentField

Sets ConfigurationField.setParentField(ConfigurationParentField)

Default: an empty parent field

Returns:

the array of ParentFields

Default:

@com.pingidentity.pa.sdk.ui.ParentField(fieldName="")