com.izforge.izpack.installer.panel
Interface PanelView<T>

All Known Implementing Classes:

AbstractPanelView, AutomatedPanelView, ConsolePanelView, IzPanelView

public interface PanelView<T>

Encapsulates a Panel and its user-interface representation.

Author:

Tim Anderson

Method Summary

boolean	canShow() Determines if the panel can be shown.
void	createInstallationRecord(IXMLElement rootElement) Creates an installation record for unattended installations and adds it to a XML root element.
int	getIndex() Returns the panel index.
Panel	getPanel() Returns the panel.
String	getPanelId() Returns the panel identifier.
T	getView() Returns the panel user interface.
boolean	isValid() Determines if the panel is valid.
boolean	isValid(boolean refreshVariables) Determines if the panel is valid.
boolean	isVisible() Determines the visibility of the panel.
void	saveData() Save the contents of the panel into install data.
void	setIndex(int index) Sets the panel index.
void	setVisible(boolean visible) Sets the visibility of the panel.

Method Detail

getPanelId

String getPanelId()

Returns the panel identifier.

Returns:

the panel identifier

getPanel

Panel getPanel()

Returns the panel.

Returns:

the panel

getIndex

int getIndex()

Returns the panel index.
This is the offset of the panel relative to the other panels, visible or not.

Returns:

the panel index

setIndex

void setIndex(int index)

Sets the panel index.

Parameters:

index - the index

getView

T getView()

Returns the panel user interface.
The view will be created if it doesn't exist.
If the panel has a DataValidator specified, this will be constructed, with both the panel and view supplied for injection into it's constructor.

Returns:

the panel user interface

setVisible

void setVisible(boolean visible)

Sets the visibility of the panel.

Parameters:

visible - if true the panel is visible, otherwise it is hidden

isVisible

boolean isVisible()

Determines the visibility of the panel.

Returns:

true if the panel is visible, false if it is hidden

isValid

boolean isValid()

Determines if the panel is valid.

This:

1. Refreshes variables
2. Executes any pre-validation panel actions
3. Validates any DynamicInstallerRequirementValidators returned by InstallData.getDynamicInstallerRequirements()
4. Validates any DataValidator associated with the panel
5. Executes any post-validation panel actions

Returns:

true if the panel is valid, otherwise false

isValid

boolean isValid(boolean refreshVariables)

Determines if the panel is valid.

This:

1. Executes any pre-validation panel actions
2. Validates any DynamicInstallerRequirementValidators returned by InstallData.getDynamicInstallerRequirements()
3. Validates any DataValidator associated with the panel
4. Executes any post-validation panel actions

Parameters:

refreshVariables - whether to refresh dynamic variables before validating

Returns:

true if the panel is valid, otherwise false

saveData

void saveData()

Save the contents of the panel into install data.

canShow

boolean canShow()

Determines if the panel can be shown.

Returns:

true if the panel can be shown

createInstallationRecord

void createInstallationRecord(IXMLElement rootElement)

Creates an installation record for unattended installations and adds it to a XML root element.

Parameters:

rootElement - the root to add child elements to