Panel (IzPack api module 5.2.4 API)

java.lang.Object
- com.izforge.izpack.api.handler.DefaultConfigurationHandler
- - com.izforge.izpack.api.data.Panel

All Implemented Interfaces:

Configurable, Serializable
```
public class Panel
extends DefaultConfigurationHandler
implements Serializable
```
Author:

Jan Blok, Dennis Reil,

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Panel.ConfirmQuitType
Whether we confirm quit from this panel.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Panel.ConfirmQuitType` Whether we confirm quit from this panel.

Constructor Summary

Constructors
Constructor and Description

Panel()

Constructors
Constructor and Description
`Panel()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addPostValidationAction(PanelActionConfiguration action)`
`void`	`addPreActivationAction(PanelActionConfiguration action)`
`void`	`addPreConstructionAction(PanelActionConfiguration action)`
`void`	`addPreValidationAction(PanelActionConfiguration action)`
`void`	`addValidator(String validatorClassName, String validatorConditionId, Configurable configurable)` Adds a panel validator and a condition defining whether the panel validator should be asked at all.
`Set<String>`	`getAffectedVariableNames()` Gets a unique collection of names of variables that might me affected when this panel is active.
`String`	`getClassName()`
`String`	`getCondition()`
`Panel.ConfirmQuitType`	`getConfirmQuitType()` Gets the behavior when quit is pressed on this panel.
`String`	`getDisplayHiddenCondition()` Get the 'displayHiddenCondition' of this panel.
`String`	`getHelpUrl(String localeISO3)`
`List<OsModel>`	`getOsConstraints()`
`String`	`getPanelId()`
`List<PanelActionConfiguration>`	`getPostValidationActions()`
`List<PanelActionConfiguration>`	`getPreActivationActions()`
`List<PanelActionConfiguration>`	`getPreConstructionActions()`
`List<PanelActionConfiguration>`	`getPreValidationActions()`
`String`	`getReadonlyCondition()` Get the 'readonlyCondition' of this panel.
`String`	`getValidatorCondition(int index)` Gets a validator condition
`Configurable`	`getValidatorConfiguration(int index)` Gets a validator condition
`List<String>`	`getValidators()` Get validator and validator condition entries for this panel
`boolean`	`hasCondition()`
`boolean`	`hasDisplayHiddenCondition()` Whether the 'displayHiddenCondition' is set for this panel.
`boolean`	`hasPanelId()`
`boolean`	`hasReadonlyCondition()` Whether the 'readonlyCondition' is set for this panel.
`boolean`	`isDisplayHidden()`
`boolean`	`isReadonly()`
`boolean`	`isVisited()`
`void`	`setAffectedVariableNames(Set<String> names)` Adds or completes a collection of names of variables that might me affected when this panel is active.
`void`	`setClassName(String className)`
`void`	`setCondition(String condition)`
`void`	`setConfirmQuitType(Panel.ConfirmQuitType value)` Sets the behavior when quit is pressed on this panel.
`void`	`setDisplayHidden(boolean flag)`
`void`	`setDisplayHiddenCondition(String condition)` Set the 'displayHiddenCondition' of this panel.
`void`	`setHelps(List<Help> helps)`
`void`	`setOsConstraints(List<OsModel> osConstraints)`
`void`	`setPanelId(String panelId)`
`void`	`setReadonly(boolean flag)`
`void`	`setReadonlyCondition(String condition)` Set the 'readonlyCondition' of this panel.
`void`	`setVisited(boolean visited)` Mark panel visited for summarizing the installation story
`String`	`toString()`

Methods inherited from class com.izforge.izpack.api.handler.DefaultConfigurationHandler
addConfigurationOption, getConfigurationOption, getConfigurationOptionValue, getConfigurationOptionValue, getConfigurationOptionValue, getNames, readParameters

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Panel
```
public Panel()
```
- Method Detail
  - getClassName
```
public String getClassName()
```
  - setClassName
```
public void setClassName(String className)
```
  - hasPanelId
```
public boolean hasPanelId()
```
  - getPanelId
```
public String getPanelId()
```
  - setPanelId
```
public void setPanelId(String panelId)
```
  - getCondition
```
public String getCondition()
```
    Returns:
    
    the condition
  - setCondition
```
public void setCondition(String condition)
```
    Parameters:
    
    condition - the condition to set
  - hasCondition
```
public boolean hasCondition()
```
  - getDisplayHiddenCondition
```
public String getDisplayHiddenCondition()
```
    Get the 'displayHiddenCondition' of this panel.
    
    Returns:
    
    the condition to set when the panel should be shown read-only in otherwise hidden state
  - setDisplayHiddenCondition
```
public void setDisplayHiddenCondition(String condition)
```
    Set the 'displayHiddenCondition' of this panel.
    
    Parameters:
    
    condition - the condition to set when the panel should be shown read-only in otherwise hidden state
  - hasDisplayHiddenCondition
```
public boolean hasDisplayHiddenCondition()
```
    Whether the 'displayHiddenCondition' is set for this panel.
    
    Returns:
    
    the condition to set when the panel should be shown read-only in otherwise hidden state
  - isDisplayHidden
```
public boolean isDisplayHidden()
```
  - setDisplayHidden
```
public void setDisplayHidden(boolean flag)
```
  - isReadonly
```
public boolean isReadonly()
```
  - setReadonly
```
public void setReadonly(boolean flag)
```
  - getReadonlyCondition
```
public String getReadonlyCondition()
```
    Get the 'readonlyCondition' of this panel.
    
    Returns:
    
    the condition to set when the panel should be shown read-only
  - setReadonlyCondition
```
public void setReadonlyCondition(String condition)
```
    Set the 'readonlyCondition' of this panel.
    
    Parameters:
    
    condition - the condition to set when the panel should be shown read-only
  - hasReadonlyCondition
```
public boolean hasReadonlyCondition()
```
    Whether the 'readonlyCondition' is set for this panel.
    
    Returns:
    
    the condition to set when the panel should be shown read-only
  - getValidators
```
public List<String> getValidators()
```
    Get validator and validator condition entries for this panel
    
    Returns:
    
    Returns a list of validator class names and optional conditions defining whether the panel validator should be asked at all.
  - getValidatorCondition
```
public String getValidatorCondition(int index)
```
    Gets a validator condition
    
    Parameters:
    
    index - the order number of the validator within the panel definition
    
    Returns:
    
    the validator condition of a validator at the given index for this panel
  - getValidatorConfiguration
```
public Configurable getValidatorConfiguration(int index)
```
    Gets a validator condition
    
    Parameters:
    
    index - the order number of the validator within the panel definition
    
    Returns:
    
    the configuration options of a validator at the given index for this panel
  - addValidator
```
public void addValidator(String validatorClassName,
                         String validatorConditionId,
                         Configurable configurable)
```
    Adds a panel validator and a condition defining whether the panel validator should be asked at all.
    
    Parameters:
    
    validatorClassName - the class name the validator
    
    validatorConditionId - the validator condition for this panel (set null for no condition)
    
    configurable - configuration options assigned to the validator (nested 'configuration' tag)
  - setHelps
```
public void setHelps(List<Help> helps)
```
  - getPreConstructionActions
```
public List<PanelActionConfiguration> getPreConstructionActions()
```
  - addPreConstructionAction
```
public void addPreConstructionAction(PanelActionConfiguration action)
```
  - getPreActivationActions
```
public List<PanelActionConfiguration> getPreActivationActions()
```
  - addPreActivationAction
```
public void addPreActivationAction(PanelActionConfiguration action)
```
  - getPreValidationActions
```
public List<PanelActionConfiguration> getPreValidationActions()
```
  - addPreValidationAction
```
public void addPreValidationAction(PanelActionConfiguration action)
```
  - getPostValidationActions
```
public List<PanelActionConfiguration> getPostValidationActions()
```
  - addPostValidationAction
```
public void addPostValidationAction(PanelActionConfiguration action)
```
  - getOsConstraints
```
public List<OsModel> getOsConstraints()
```
  - setOsConstraints
```
public void setOsConstraints(List<OsModel> osConstraints)
```
  - getHelpUrl
```
public String getHelpUrl(String localeISO3)
```
  - isVisited
```
public boolean isVisited()
```
    Returns:
    
    Whether the panel has been visited for summarizing the installation story
  - setVisited
```
public void setVisited(boolean visited)
```
    Mark panel visited for summarizing the installation story
    
    Parameters:
    
    visited - whether the panel has been shown to the user
  - getAffectedVariableNames
```
public Set<String> getAffectedVariableNames()
```
    Gets a unique collection of names of variables that might me affected when this panel is active.
    
    Returns:
    
    Set of variable names
  - setAffectedVariableNames
```
public void setAffectedVariableNames(Set<String> names)
```
    Adds or completes a collection of names of variables that might me affected when this panel is active.
    
    Affected variables are blocked for further dynamic changes if there are definitions as dynamic variables as soon as the user passes forward over this panel
    
    Parameters:
    
    names - Affected variables
  - getConfirmQuitType
```
public Panel.ConfirmQuitType getConfirmQuitType()
```
    Gets the behavior when quit is pressed on this panel.
    
    Returns:
    
    the confirmation options of this panel
  - setConfirmQuitType
```
public void setConfirmQuitType(Panel.ConfirmQuitType value)
```
    Sets the behavior when quit is pressed on this panel.
    
    Parameters:
    
    value - the confirmation options of this panel
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Panel

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class com.izforge.izpack.api.handler.DefaultConfigurationHandler

Methods inherited from class java.lang.Object

Constructor Detail

Panel

Method Detail

getClassName

setClassName

hasPanelId

getPanelId

setPanelId

getCondition

setCondition

hasCondition

getDisplayHiddenCondition

setDisplayHiddenCondition

hasDisplayHiddenCondition

isDisplayHidden

setDisplayHidden

isReadonly

setReadonly

getReadonlyCondition

setReadonlyCondition

hasReadonlyCondition

getValidators

getValidatorCondition

getValidatorConfiguration

addValidator

setHelps

getPreConstructionActions

addPreConstructionAction

getPreActivationActions

addPreActivationAction

getPreValidationActions

addPreValidationAction

getPostValidationActions

addPostValidationAction

getOsConstraints

setOsConstraints

getHelpUrl

isVisited

setVisited

getAffectedVariableNames

setAffectedVariableNames

getConfirmQuitType

setConfirmQuitType

toString