com.izforge.izpack.panels.userinput.gui.rule
Class GUIRuleField

java.lang.Object
  com.izforge.izpack.panels.userinput.field.AbstractFieldView
      com.izforge.izpack.panels.userinput.gui.GUIField
          com.izforge.izpack.panels.userinput.gui.rule.GUIRuleField

All Implemented Interfaces:

FieldView

public class GUIRuleField
extends GUIField

Rule field view.

Author:

Tim Anderson

Constructor Summary

GUIRuleField(RuleField field)
Constructs a GUIRuleField.

Method Summary

JComponent	getFirstFocusableComponent() Return a JComponent of this field which is the primary candidate to gain focus.
String	getValue() Returns the text from the display, according to the field's formatting convention.
String[]	getValues() Returns each sub-field value.
void	setValues(String... values) Sets the sub-field values.
boolean	updateField(Prompt prompt, boolean skipValidation) Updates the field from the view.
boolean	updateView() Updates the view from the field.

Methods inherited from class com.izforge.izpack.panels.userinput.gui.GUIField

addComponent, addDescription, addField, addLabel, addLabel, addText, addTooltip, getComponents, getInstallData, notifyUpdateListener, replaceVariables, setUpdateListener, translateStaticText, updateField, warning

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

getField, getSummaryKey, getVariable, isDisplayed, isReadonly, setDisplayed, setReadonly, setVariable

Methods inherited from class java.lang.Object

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

Constructor Detail

GUIRuleField

public GUIRuleField(RuleField field)

Constructs a GUIRuleField.

Parameters:

field - the field

Method Detail

getValue

public String getValue()

Returns the text from the display, according to the field's formatting convention.

Returns:

the formatted text

getValues

public String[] getValues()

Returns each sub-field value.

Returns:

the sub-field values

setValues

public void setValues(String... values)

Sets the sub-field values.

Parameters:

values - the sub-field values

updateField

public boolean updateField(Prompt prompt,
                           boolean skipValidation)

Updates the field from the view.

Overrides:

updateField in class GUIField

Parameters:

prompt - the prompt to display messages

skipValidation - set to true when wanting to save field data without validating

Returns:

true if the field was updated, false if the view is invalid

updateView

public boolean updateView()

Updates the view from the field.

Overrides:

updateView in class GUIField

Returns:

true if the view was updated

getFirstFocusableComponent

public JComponent getFirstFocusableComponent()

Description copied from class: GUIField

Return a JComponent of this field which is the primary candidate to gain focus.

Specified by:

getFirstFocusableComponent in class GUIField

Returns:

the primary JComponent to gain focus