com.izforge.izpack.panels.userinput.field.button
Class ButtonFieldReader

java.lang.Object
  com.izforge.izpack.panels.userinput.field.ElementReader
      com.izforge.izpack.panels.userinput.field.FieldReader
          com.izforge.izpack.panels.userinput.field.SimpleFieldReader
              com.izforge.izpack.panels.userinput.field.button.ButtonFieldReader

All Implemented Interfaces:

ButtonFieldConfig, FieldConfig

public class ButtonFieldReader
extends SimpleFieldReader
implements ButtonFieldConfig

Field Summary

static String	RUN_ELEMENT
static String	RUN_ELEMENT_CLASS_ATTR
static String	RUN_MSG_ELEMENT
static String	RUN_MSG_ELEMENT_ID_ATTR
static String	RUN_MSG_ELEMENT_NAME_ATTR
static String	SPEC_SUCCESSMSG_ATTR

Fields inherited from class com.izforge.izpack.panels.userinput.field.FieldReader

OMIT_FROM_AUTO, SPEC, VARIABLE

Constructor Summary

ButtonFieldReader(IXMLElement field, Config config, InstallData installData)
Constructs a FieldReader.

Method Summary

List<ButtonAction>	getButtonActions() Get all the actions the button should run.
String	getButtonName() Get the button's name
String	getLabel() Returns the text label.
protected IXMLElement	getSpec(IXMLElement field, Config config) Allow retrival of specification
String	getSuccessMsg() Get success message to be sent to the user if all the button's actions suceeed.

Methods inherited from class com.izforge.izpack.panels.userinput.field.SimpleFieldReader

getOmitFromAuto, getVariable

Methods inherited from class com.izforge.izpack.panels.userinput.field.FieldReader

getCondition, getDefaultValue, getDescription, getDisplayHiddenCondition, getField, getInitialValue, getOsModels, getPacks, getProcessors, getReadonlyCondition, getSize, getSpec, getSummaryKey, getText, getTooltip, getValidators, getValidators, isDisplayHidden, isReadonly

Methods inherited from class com.izforge.izpack.panels.userinput.field.ElementReader

getComplexPanelCondition, getConfig, getOsModels, getPacks, getUnselectedPacks

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

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

Field Detail

SPEC_SUCCESSMSG_ATTR

public static final String SPEC_SUCCESSMSG_ATTR

See Also:

Constant Field Values

RUN_ELEMENT

public static final String RUN_ELEMENT

See Also:

Constant Field Values

RUN_ELEMENT_CLASS_ATTR

public static final String RUN_ELEMENT_CLASS_ATTR

See Also:

Constant Field Values

RUN_MSG_ELEMENT

public static final String RUN_MSG_ELEMENT

See Also:

Constant Field Values

RUN_MSG_ELEMENT_ID_ATTR

public static final String RUN_MSG_ELEMENT_ID_ATTR

See Also:

Constant Field Values

RUN_MSG_ELEMENT_NAME_ATTR

public static final String RUN_MSG_ELEMENT_NAME_ATTR

See Also:

Constant Field Values

Constructor Detail

ButtonFieldReader

public ButtonFieldReader(IXMLElement field,
                         Config config,
                         InstallData installData)

Constructs a FieldReader.

Parameters:

field - the field element to read

config - the configuration

Method Detail

getSpec

protected IXMLElement getSpec(IXMLElement field,
                              Config config)

Allow retrival of specification

Overrides:

getSpec in class SimpleFieldReader

Parameters:

field - the parent field element

config - the configuration

Returns:

getLabel

public String getLabel()

Returns the text label.

Specified by:

getLabel in interface FieldConfig

Overrides:

getLabel in class FieldReader

Returns:

the text label

getButtonName

public String getButtonName()

Get the button's name

Specified by:

getButtonName in interface ButtonFieldConfig

Returns:

getSuccessMsg

public String getSuccessMsg()

Get success message to be sent to the user if all the button's actions suceeed.

Specified by:

getSuccessMsg in interface ButtonFieldConfig

Returns:

getButtonActions

public List<ButtonAction> getButtonActions()

Get all the actions the button should run.

Specified by:

getButtonActions in interface ButtonFieldConfig