com.izforge.izpack.panels.userinput.field
Interface FieldConfig

All Known Subinterfaces:

ButtonFieldConfig, CheckFieldConfig, ChoiceFieldConfig, CustomFieldConfig, DirFieldConfig, DividerConfig, FileFieldConfig, MultipleFileFieldConfig, PasswordGroupFieldConfig, RuleFieldConfig, SearchFieldConfig, TitleFieldConfig

All Known Implementing Classes:

AbstractFileFieldReader, ButtonFieldReader, CheckFieldReader, CustomFieldReader, DirFieldReader, DividerReader, FieldReader, FileFieldReader, MultipleFileFieldReader, PasswordGroupFieldReader, RuleFieldReader, SearchFieldReader, SimpleChoiceReader, SimpleFieldReader, StaticTextFieldReader, TitleFieldReader

public interface FieldConfig

User-input field configuration.

Author:

Tim Anderson

Method Summary

String	getCondition() Returns the condition that determines if the field is displayed or not.
String	getDefaultValue() Returns the default value to be used for the field.
String	getDescription() Returns the field description.
String	getDisplayHiddenCondition() Returns a condition for which the field should be displayed read-only on the panel regardless if its conditionid is true or false.
String	getInitialValue() Returns the initial value to be used for the field.
String	getLabel() Returns the field label.
boolean	getOmitFromAuto() Returns the value of 'omitFromAuto' from fields spec
List<OsModel>	getOsModels() Returns the operating systems that this field applies to.
List<String>	getPacks() Returns the packs that this field applies to.
List<FieldProcessor>	getProcessors() Returns the processor the field.
String	getReadonlyCondition() Returns a condition for which the field should be displayed read-only.
int	getSize() Returns the field size.
String	getSummaryKey() Returns the summary key associated with the field.
String	getTooltip() Returns the field's tooltip.
List<FieldValidator>	getValidators() Returns the validators for the field.
List<FieldValidator>	getValidators(IXMLElement field) Returns the validators for the given field.
String	getVariable() Returns the variable that the field reads and updates.
Boolean	isDisplayHidden() Returns if the field should always be displayed read-only on the panel regardless if its conditionid is true or false.
Boolean	isReadonly() Returns if the field should always be displayed read-only.

Method Detail

getVariable

String getVariable()

Returns the variable that the field reads and updates.

Returns:

the 'variable' attribute, or null if the variable is optional but not present

Throws:

IzPackException - if the 'variable' attribute is mandatory but not present

getSummaryKey

String getSummaryKey()

Returns the summary key associated with the field.

Returns:

the 'summaryKey' attribute, or null if the summary attribute is not present

isDisplayHidden

Boolean isDisplayHidden()

Returns if the field should always be displayed read-only on the panel regardless if its conditionid is true or false.

Returns:

the 'displayHidden' attribute, or false

getDisplayHiddenCondition

String getDisplayHiddenCondition()

Returns a condition for which the field should be displayed read-only on the panel regardless if its conditionid is true or false. If the condition evaluates false, don't apply displayHidden.

Returns:

the condition, or null

isReadonly

Boolean isReadonly()

Returns if the field should always be displayed read-only.

Returns:

the 'readonly' attribute, or false

getReadonlyCondition

String getReadonlyCondition()

Returns a condition for which the field should be displayed read-only. If the conditionid is false, don't apply readonly.

Returns:

the 'readonlyCondition' attribute, or null

getPacks

List<String> getPacks()

Returns the packs that this field applies to.

Returns:

the list of pack names

getOsModels

List<OsModel> getOsModels()

Returns the operating systems that this field applies to.

Returns:

the operating systems, or an empty list if the field applies to all operating systems

getDefaultValue

String getDefaultValue()

Returns the default value to be used for the field.

Returns:

the default value. May be null

getInitialValue

String getInitialValue()

Returns the initial value to be used for the field.

Returns:

the initial value. May be null

getSize

int getSize()

Returns the field size.

Returns:

the field size, or -1 if no size is specified, or the specified size is invalid

getValidators

List<FieldValidator> getValidators()

Returns the validators for the field.

Returns:

the validators for the field

getValidators

List<FieldValidator> getValidators(IXMLElement field)

Returns the validators for the given field.

Parameters:

field -

Returns:

the validators for the given field

getProcessors

List<FieldProcessor> getProcessors()

Returns the processor the field.

Returns:

the field processor, or null if none exists

getDescription

String getDescription()

Returns the field description.

Returns:

the field description. May be @{code null}

getTooltip

String getTooltip()

Returns the field's tooltip.

Returns:

the field tooltip. May be @{code null}

getLabel

String getLabel()

Returns the field label.

Returns:

the field label. May be null

getCondition

String getCondition()

Returns the condition that determines if the field is displayed or not.

Returns:

the condition. May be null

getOmitFromAuto

boolean getOmitFromAuto()

Returns the value of 'omitFromAuto' from fields spec

Returns:

the 'omitFromAuto' attribute