com.izforge.izpack.api.installer

Interface ISummarisable

public interface ISummarisable

Created by IntelliJ IDEA. User: sora Date: Dec 6, 2009 Time: 5:33:35 PM To change this template use File | Settings | File Templates.

Method Summary

Modifier and Type	Method and Description
String	getSummaryBody() This method will be called to get the summary of this class which should be placed in the SummaryPanel.
String	getSummaryCaption() This method will be called to get the caption for this class which should be placed in the SummaryPanel.
boolean	isVisited() Checks if the panel has been visited during the input process or not.

Method Detail

getSummaryBody

String getSummaryBody()

This method will be called to get the summary of this class which should be placed in the SummaryPanel. The returned text should not contain a caption of this item. The caption will be requested from the method getCaption. If null returns, no summary for this panel will be generated. Default behaviour is to return null.

Returns:

the summary for this class

getSummaryCaption

String getSummaryCaption()

This method will be called to get the caption for this class which should be placed in the SummaryPanel. If null returns, no summary for this panel will be generated. Default behaviour is to return the string given by langpack for the key <current class name>.summaryCaption> if exist, else the string "summaryCaption.<ClassName>".

Returns:

the caption for this class

isVisited

boolean isVisited()

Checks if the panel has been visited during the input process or not. This method allows the implementer to conditionally show infos within the summary panel.

Returns:

true if the panel was displayed, false otherwise