com.izforge.izpack.panels.userinput.field.search
Interface SearchFieldConfig

All Superinterfaces:

FieldConfig

All Known Implementing Classes:

SearchFieldReader

public interface SearchFieldConfig
extends FieldConfig

Search field configuration.

Author:

Tim Anderson

Method Summary

String	getCheckFilename() Returns the filename to check the existence of.
List<String>	getChoices() Returns the search choices.
String	getFilename() Returns the filename to search on.
ResultType	getResultType() Returns the result type.
SearchType	getSearchType() Returns the search type.
int	getSelectedIndex() Returns the index of the selected choice.

Methods inherited from interface com.izforge.izpack.panels.userinput.field.FieldConfig

getCondition, getDefaultValue, getDescription, getDisplayHiddenCondition, getInitialValue, getLabel, getOmitFromAuto, getOsModels, getPacks, getProcessors, getReadonlyCondition, getSize, getSummaryKey, getTooltip, getValidators, getValidators, getVariable, isDisplayHidden, isReadonly

Method Detail

getFilename

String getFilename()

Returns the filename to search on.

Returns:

the filename to search on. May be null

getCheckFilename

String getCheckFilename()

Returns the filename to check the existence of.

Returns:

the filename to to check the existence of. May be null

getSearchType

SearchType getSearchType()

Returns the search type.

Returns:

the search type

getResultType

ResultType getResultType()

Returns the result type.

Returns:

the result type

Throws:

IzPackException - if the attribute is not present or is invalid

getChoices

List<String> getChoices()

Returns the search choices.

Returns:

the search choices

getSelectedIndex

int getSelectedIndex()

Returns the index of the selected choice.

A choice is selected if the "set" attribute is 'true'.

This is only valid after getChoices() is invoked.

Returns:

the selected index or -1 if no choice is selected