com.izforge.izpack.installer
Class IzPanel

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  com.izforge.izpack.installer.IzPanel

All Implemented Interfaces:

LayoutConstants, AbstractUIHandler, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.SwingConstants

Direct Known Subclasses:

CompilePanel, DataCheckPanel, FinishPanel, HelloPanel, HTMLInfoPanel, HTMLLicencePanel, InfoPanel, InstallationGroupPanel, InstallationTypePanel, InstallPanel, LicencePanel, PacksPanelBase, PathInputPanel, ProcessPanel, SelectPrinterPanel, ShortcutPanel, SimpleFinishPanel, SudoPanel, SummaryPanel, TreePacksPanel, UserInputPanel, UserPathInputPanel, XInfoPanel

public class IzPanel
extends javax.swing.JPanel
implements AbstractUIHandler, LayoutConstants

Defines the base class for the IzPack panels. Any panel should be a subclass of it and should belong to the com.izforge.izpack.panels package. Since IzPack version 3.9 the layout handling will be delegated to the class LayoutHelper which can be accessed by getLayoutHelper. There are some layout helper methods in this class which will be exist some time longer, but they are deprecated. At a redesign or new panel use the layout helper. There is a special layout manager for IzPanels. This layout manager will be supported by the layout helper. There are some points which should be observed at layouting. One point e.g. is the anchor. All IzPanels have to be able to use different anchors, as minimum CENTER and NORTHWEST. To use a consistent appearance use this special layout manger and not others.

Author:

Julien Ponge, Klaus Bartz

See Also:

Serialized Form

Nested Class Summary

static class

IzPanel.Filler

Nested classes/interfaces inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

static int	COLS_1 COLS_1 = 1
static java.lang.String	d d = D
static java.lang.String	D D = "." ( dot )
protected java.lang.String	headline internal headline string
static java.lang.String	HEADLINE HEADLINE = "headline"
protected javax.swing.JLabel	headLineLabel internal headline Label
private java.util.HashMap<java.lang.String,java.lang.String>	helps
private HelpWindow	helpWindow
protected boolean	hidden Is this panel general hidden or not
protected InstallData	idata The installer internal data (actually a melting-pot class with all-public fields.
protected java.awt.Component	initialFocus The component which should get the focus at activation
protected LayoutHelper	layoutHelper The helper object which handles layout
Panel	metadata Information about the panel
protected java.lang.String	myClassname myClassname=i.e "FinishPanel"
protected java.lang.String	myFullClassname i.e.
protected java.lang.String	myPrefix i.e.
protected InstallerFrame	parent The parent IzPack installer frame.
private java.util.List<PanelAction>	postValidateActions
private java.util.List<PanelAction>	preActivateActions
private java.util.List<PanelAction>	preValidateActions
static int	ROWS_1 ROWS_1 = 1
private static long	serialVersionUID
private DataValidator	validationService
static int	X_ORIGIN X_ORIGIN = 0
static int	Y_ORIGIN Y_ORIGIN = 0

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface com.izforge.izpack.util.AbstractUIHandler

ANSWER_CANCEL, ANSWER_NO, ANSWER_YES, CHOICES_YES_NO, CHOICES_YES_NO_CANCEL

Fields inherited from interface com.izforge.izpack.gui.LayoutConstants

ABSOLUTE_STRETCH, ALL_GAP, AUTOMATIC_GAP, CONTROL_CONSTRAINT, CONTROL_GAP, CONTROL_TO_LABEL_GAP, CONTROL_TO_TEXT_GAP, CURRENT_COLUMN, CURRENT_ROW, DEFAULT_CONTROL_ALIGNMENT, DEFAULT_LABEL_ALIGNMENT, DEFAULT_TEXT_ALIGNMENT, FILL_OUT_COLUMN_HEIGHT, FILL_OUT_COLUMN_SIZE, FILL_OUT_COLUMN_WIDTH, FILLER1_GAP, FILLER13_GAP, FILLER2_GAP, FILLER4_GAP, FILLER5_GAP, FULL_COLUMN_STRETCH, FULL_LINE_COMPONENT_CONSTRAINT, FULL_LINE_CONTROL_CONSTRAINT, FULL_LINE_STRETCH, GAP_LOAD_MARKER, LABEL_CONSTRAINT, LABEL_GAP, LABEL_TO_CONTROL_GAP, LABEL_TO_TEXT_GAP, NEXT_COLUMN, NEXT_LINE, NEXT_ROW, NO_FILL_OUT_COLUMN, NO_GAP, NO_STRETCH, PARAGRAPH_GAP, RELATIVE_STRETCH, TEXT_CONSTRAINT, TEXT_GAP, TEXT_TO_CONTROL_GAP, TEXT_TO_LABEL_GAP, TOP_GAP, XDUMMY_CONSTRAINT, XY_VARIABLE_CONSTRAINT, YDUMMY_CONSTRAINT

Fields inherited from interface javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

IzPanel(InstallerFrame parent, InstallData idata)
The constructor.

IzPanel(InstallerFrame parent, InstallData idata, java.awt.LayoutManager2 lm)
Creates a new IzPanel object with the given layout manager.

IzPanel(InstallerFrame parent, InstallData idata, java.lang.String iconName)
Creates a new IzPanel object.

IzPanel(InstallerFrame parent, InstallData idata, java.lang.String iconName, int instance)
The constructor with Icon.

Method Summary

void	addPostValidationAction(PanelAction postValidateAction)
void	addPreActivationAction(PanelAction preActivateAction)
void	addPreValidationAction(PanelAction preValidateAction)
int	askQuestion(java.lang.String title, java.lang.String question, int choices) Ask the user a question.
int	askQuestion(java.lang.String title, java.lang.String question, int choices, int default_choice) Ask the user a question.
protected boolean	buildHeadline(java.lang.String imageIconName, int instanceNumber) Build the IzPanel internal Headline.
boolean	canShowHelp() Indicates wether the panel can display help.
void	completeGridBagLayout() Deprecated. use getLayoutHelper().completeLayout instead
javax.swing.JLabel	createLabel(java.lang.String textId, java.lang.String iconId, int pos) Creates a label via LabelFactory with the given ids and the given horizontal alignment.
javax.swing.JLabel	createLabel(java.lang.String textId, java.lang.String iconId, int pos, boolean isFullLine) Creates a label via LabelFactory with the given ids and the given horizontal alignment.
javax.swing.JLabel	createLabel(java.lang.String subkey, java.lang.String alternateClass, java.lang.String iconId, int pos) Creates a label via LabelFactory using iconId, pos and method getI18nStringForClass for resolving the text to be used.
javax.swing.JLabel	createLabel(java.lang.String subkey, java.lang.String alternateClass, java.lang.String iconId, int pos, boolean isFullLine) Creates a label via LabelFactory using iconId, pos and method getI18nStringForClass for resolving the text to be used.
MultiLineLabel	createMultiLineLabel(java.lang.String text) Creates a multi line label with the given text.
MultiLineLabel	createMultiLineLabel(java.lang.String text, java.lang.String iconId, int pos) Creates a label via LabelFactory with the given text, the given icon id and the given horizontal alignment.
MultiLineLabel	createMultiLineLabelLang(java.lang.String textId) Creates a multi line label with the language dependent text given by the text id.
void	emitError(java.lang.String title, java.lang.String message) Notify the user of some error.
void	emitErrorAndBlockNext(java.lang.String title, java.lang.String message) Notify the user of some error and block the next button.
void	emitNotification(java.lang.String message) Notify the user about something.
boolean	emitNotificationFeedback(java.lang.String message)
boolean	emitWarning(java.lang.String title, java.lang.String message) Warn the user about something.
protected void	executePostValidationActions()
protected void	executePreActivationActions()
protected void	executePreValidationActions()
protected void	getClassName() Gets and fills the classname fields
java.awt.Font	getControlTextFont() The Font of Labels in many cases
java.awt.GridBagConstraints	getDefaultGridBagConstraints() Deprecated. use getLayoutHelper().getDefaulConstraints instead
java.lang.String	getHelpUrl(java.lang.String isoCode)
private HelpWindow	getHelpWindow()
java.lang.String	getI18nStringForClass(java.lang.String subkey) Calls the langpack of parent InstallerFrame for the String RuntimeClassName.subkey.
java.lang.String	getI18nStringForClass(java.lang.String subkey, java.lang.String alternateClass) Calls the langpack of parent InstallerFrame for the String RuntimeClassName.subkey.
private java.lang.String	getI18nStringForClass(java.lang.String curClassName, java.lang.String subkey, java.lang.String alternateClass)
javax.swing.ImageIcon	getImageIcon(java.lang.String iconName) Gets a named image icon
java.awt.Component	getInitialFocus() Returns the component which should be get the focus at activation of this panel.
InstallerFrame	getInstallerFrame() Returns the parent of this IzPanel (which is a InstallerFrame).
protected static javax.swing.plaf.metal.MetalLookAndFeel	getLAF()
LayoutHelper	getLayoutHelper() Returns the used layout helper.
Panel	getMetadata()
java.awt.GridBagConstraints	getNewGridBagConstraints(int gridx, int gridy) Deprecated. use getLayoutHelper().getNewConstraints instead
java.awt.GridBagConstraints	getNewGridBagConstraints(int gridx, int gridy, int gridwidth, int gridheight) Deprecated. use getLayoutHelper().getNewConstraints instead
java.awt.GridBagConstraints	getNextXGridBagConstraints() Deprecated. use getLayoutHelper().getNextXConstraints instead
java.awt.GridBagConstraints	getNextYGridBagConstraints() Deprecated. use getLayoutHelper().getNextYConstraints instead
java.awt.GridBagConstraints	getNextYGridBagConstraints(int gridwidth, int gridheight) Deprecated. use getLayoutHelper().getNextYConstraints instead
java.lang.String	getString(java.lang.String key) Gets a language Resource String from the parent, which holds these global resource.
java.lang.String	getSummaryBody() This method will be called from the SummaryPanel to get the summary of this class which should be placed in the SummaryPanel.
java.lang.String	getSummaryCaption() This method will be called from the SummaryPanel to get the caption for this class which should be placed in the SummaryPanel.
DataValidator	getValidationService()
protected void	init(InstallerFrame parent, InstallData idata) Internal init method
protected void	initLayoutHelper() Inits and sets the internal layout helper object.
boolean	isHidden() Returns whether this panel will be hidden general or not.
protected boolean	isValidated() Indicates wether the panel has been validated or not.
void	makeXMLData(IXMLElement panelRoot) Asks the panel to set its own XML data that can be brought back for an automated installation process.
void	panelActivate() This method is called when the panel becomes active.
void	panelDeactivate() This method is called when the panel gets desactivated, when the user switches to the next panel.
boolean	panelValidated()
protected java.lang.String	parseText(java.lang.String string_to_parse) Parses the text for special variables.
void	resetGridCounter() Deprecated. use getLayoutHelper().resetGridCounter instead
void	setDefaultGridBagConstraints(java.awt.GridBagConstraints constraints) Deprecated. use getLayoutHelper().setDefaultConstraints instead
void	setHelps(java.util.HashMap helps)
void	setHidden(boolean hidden) Set whether this panel should be hidden or not.
void	setInitialFocus(java.awt.Component component) Sets the component which should be get the focus at activation of this panel.
void	setMetadata(Panel p)
void	setValidationService(DataValidator validationService)
void	showHelp() This method is called when Help button has been clicked.
void	startGridBagLayout() Deprecated. use getLayoutHelper().startLayout instead
private boolean	validatePanel() This method validates the field content.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

layoutHelper

protected LayoutHelper layoutHelper

The helper object which handles layout

initialFocus

protected java.awt.Component initialFocus

The component which should get the focus at activation

idata

protected InstallData idata

The installer internal data (actually a melting-pot class with all-public fields.

parent

protected InstallerFrame parent

The parent IzPack installer frame.

myFullClassname

protected java.lang.String myFullClassname

i.e. "com.izforge.izpack.panels.HelloPanel"

myClassname

protected java.lang.String myClassname

myClassname=i.e "FinishPanel"

myPrefix

protected java.lang.String myPrefix

i.e. "FinishPanel." useFull for getString()

headline

protected java.lang.String headline

internal headline string

headLineLabel

protected javax.swing.JLabel headLineLabel

internal headline Label

hidden

protected boolean hidden

Is this panel general hidden or not

HEADLINE

public static final java.lang.String HEADLINE

HEADLINE = "headline"

See Also:

Constant Field Values

validationService

private DataValidator validationService

preActivateActions

private java.util.List<PanelAction> preActivateActions

preValidateActions

private java.util.List<PanelAction> preValidateActions

postValidateActions

private java.util.List<PanelAction> postValidateActions

X_ORIGIN

public static final int X_ORIGIN

X_ORIGIN = 0

See Also:

Constant Field Values

Y_ORIGIN

public static final int Y_ORIGIN

Y_ORIGIN = 0

See Also:

Constant Field Values

D

public static final java.lang.String D

D = "." ( dot )

See Also:

Constant Field Values

d

public static final java.lang.String d

d = D

See Also:

Constant Field Values

COLS_1

public static final int COLS_1

COLS_1 = 1

See Also:

Constant Field Values

ROWS_1

public static final int ROWS_1

ROWS_1 = 1

See Also:

Constant Field Values

metadata

public Panel metadata

Information about the panel

helps

private java.util.HashMap<java.lang.String,java.lang.String> helps

helpWindow

private HelpWindow helpWindow

Constructor Detail

IzPanel

public IzPanel(InstallerFrame parent,
               InstallData idata)

The constructor.

Parameters:

parent - The parent IzPack installer frame.

idata - The installer internal data.

IzPanel

public IzPanel(InstallerFrame parent,
               InstallData idata,
               java.awt.LayoutManager2 lm)

Creates a new IzPanel object with the given layout manager. Valid layout manager are the IzPanelLayout and the GridBagLayout. New panels should be use the IzPanelLaout. If lm is null, no layout manager will be created or initialized.

Parameters:

parent - The parent IzPack installer frame.

idata - The installer internal data.

lm - layout manager to be used with this IzPanel

IzPanel

public IzPanel(InstallerFrame parent,
               InstallData idata,
               java.lang.String iconName)

Creates a new IzPanel object.

Parameters:

parent - the Parent Frame

idata - Installers Runtime Data Set

iconName - The Headline IconName

IzPanel

public IzPanel(InstallerFrame parent,
               InstallData idata,
               java.lang.String iconName,
               int instance)

The constructor with Icon.

Parameters:

parent - The parent IzPack installer frame.

idata - The installer internal data.

iconName - A iconname to show as left oriented headline-leading Icon.

instance - An instance counter

Method Detail

buildHeadline

protected boolean buildHeadline(java.lang.String imageIconName,
                                int instanceNumber)

Build the IzPanel internal Headline. If an external headline# is used, this method returns immediately with false. Allows also to display a leading Icon for the PanelHeadline. This Icon can also be different if the panel has more than one Instances. The UserInputPanel is one of these Candidates.

by marc.eppelmann@gmx.de

Parameters:

imageIconName - an Iconname

instanceNumber - an panel instance

Returns:

true if successful build

getString

public java.lang.String getString(java.lang.String key)

Gets a language Resource String from the parent, which holds these global resource.

Parameters:

key - The Search key

Returns:

The Languageresource or the key if not found.

getImageIcon

public javax.swing.ImageIcon getImageIcon(java.lang.String iconName)

Gets a named image icon

Parameters:

iconName - a valid image icon

Returns:

the icon

initLayoutHelper

protected void initLayoutHelper()

Inits and sets the internal layout helper object.

getClassName

protected void getClassName()

Gets and fills the classname fields

init

protected void init(InstallerFrame parent,
                    InstallData idata)

Internal init method

Parameters:

parent - the parent frame

idata - installers runtime dataset

isValidated

protected boolean isValidated()

Indicates wether the panel has been validated or not. The installer won't let the user go further through the installation process until the panel is validated. Default behaviour is to return true.

Returns:

A boolean stating whether the panel has been validated or not.

panelValidated

public boolean panelValidated()

panelActivate

public void panelActivate()

This method is called when the panel becomes active. Default is to do nothing : feel free to implement what you need in your subclasses. A panel becomes active when the user reaches it during the installation process.

panelDeactivate

public void panelDeactivate()

This method is called when the panel gets desactivated, when the user switches to the next panel. By default it doesn't do anything.

makeXMLData

public void makeXMLData(IXMLElement panelRoot)

Asks the panel to set its own XML data that can be brought back for an automated installation process. Use it as a blackbox if your panel needs to do something even in automated mode.

Parameters:

panelRoot - The XML root element of the panels blackbox tree.

askQuestion

public int askQuestion(java.lang.String title,
                       java.lang.String question,
                       int choices)

Ask the user a question.

Specified by:

askQuestion in interface AbstractUIHandler

Parameters:

title - Message title.

question - The question.

choices - The set of choices to present.

Returns:

The user's choice.

See Also:

AbstractUIHandler.askQuestion(String, String, int)

askQuestion

public int askQuestion(java.lang.String title,
                       java.lang.String question,
                       int choices,
                       int default_choice)

Ask the user a question.

Specified by:

askQuestion in interface AbstractUIHandler

Parameters:

title - Message title.

question - The question.

choices - The set of choices to present.

default_choice - The default choice. (-1 = no default choice)

Returns:

The user's choice.

See Also:

AbstractUIHandler.askQuestion(String, String, int, int)

emitNotificationFeedback

public boolean emitNotificationFeedback(java.lang.String message)

emitNotification

public void emitNotification(java.lang.String message)

Notify the user about something.

Specified by:

emitNotification in interface AbstractUIHandler

Parameters:

message - The notification.

emitWarning

public boolean emitWarning(java.lang.String title,
                           java.lang.String message)

Warn the user about something.

Specified by:

emitWarning in interface AbstractUIHandler

Parameters:

message - The warning message.

title - The message title (used for dialog name, might not be displayed)

Returns:

true if the user decided to continue

emitError

public void emitError(java.lang.String title,
                      java.lang.String message)

Notify the user of some error.

Specified by:

emitError in interface AbstractUIHandler

Parameters:

message - The error message.

title - The message title (used for dialog name, might not be displayed)

emitErrorAndBlockNext

public void emitErrorAndBlockNext(java.lang.String title,
                                  java.lang.String message)

Notify the user of some error and block the next button.

Specified by:

emitErrorAndBlockNext in interface AbstractUIHandler

Parameters:

message - The error message.

title - The message title (used for dialog name, might not be displayed)

getInitialFocus

public java.awt.Component getInitialFocus()

Returns the component which should be get the focus at activation of this panel.

Returns:

the component which should be get the focus at activation of this panel

setInitialFocus

public void setInitialFocus(java.awt.Component component)

Sets the component which should be get the focus at activation of this panel.

Parameters:

component - which should be get the focus at activation of this panel

getI18nStringForClass

public java.lang.String getI18nStringForClass(java.lang.String subkey)

Calls the langpack of parent InstallerFrame for the String RuntimeClassName.subkey. Do not add a point infront of subkey, it is always added in this method. If RuntimeClassName.subkey is not found, the super class name will be used until it is IzPanel. If no key will be found, null returns.

Parameters:

subkey - the subkey for the string which should be returned

Returns:

the founded string

getI18nStringForClass

public java.lang.String getI18nStringForClass(java.lang.String subkey,
                                              java.lang.String alternateClass)

Calls the langpack of parent InstallerFrame for the String RuntimeClassName.subkey. Do not add a point infront of subkey, it is always added in this method. If no key will be found the key or - if alternate class is null - null returns.

Parameters:

subkey - the subkey for the string which should be returned

alternateClass - the short name of the class which should be used if no string is present with the runtime class name

Returns:

the founded string

getI18nStringForClass

private java.lang.String getI18nStringForClass(java.lang.String curClassName,
                                               java.lang.String subkey,
                                               java.lang.String alternateClass)

getInstallerFrame

public InstallerFrame getInstallerFrame()

Returns the parent of this IzPanel (which is a InstallerFrame).

Returns:

the parent of this IzPanel

createLabel

public javax.swing.JLabel createLabel(java.lang.String subkey,
                                      java.lang.String alternateClass,
                                      java.lang.String iconId,
                                      int pos)

Creates a label via LabelFactory using iconId, pos and method getI18nStringForClass for resolving the text to be used. If the icon id is null, the label will be created also.

Parameters:

subkey - the subkey which should be used for resolving the text

alternateClass - the short name of the class which should be used if no string is present with the runtime class name

iconId - id string for the icon

pos - horizontal alignment

Returns:

the newly created label

createLabel

public javax.swing.JLabel createLabel(java.lang.String subkey,
                                      java.lang.String alternateClass,
                                      java.lang.String iconId,
                                      int pos,
                                      boolean isFullLine)

Creates a label via LabelFactory using iconId, pos and method getI18nStringForClass for resolving the text to be used. If the icon id is null, the label will be created also. If isFullLine true a LabelFactory.FullLineLabel will be created instead of a JLabel. The difference between both classes are a different layout handling.

Parameters:

subkey - the subkey which should be used for resolving the text

alternateClass - the short name of the class which should be used if no string is present with the runtime class name

iconId - id string for the icon

pos - horizontal alignment

isFullLine - determines whether a FullLineLabel or a JLabel should be created

Returns:

the newly created label

createLabel

public javax.swing.JLabel createLabel(java.lang.String textId,
                                      java.lang.String iconId,
                                      int pos)

Creates a label via LabelFactory with the given ids and the given horizontal alignment. If the icon id is null, the label will be created also. The strings are the ids for the text in langpack and the icon in icons of the installer frame.

Parameters:

textId - id string for the text

iconId - id string for the icon

pos - horizontal alignment

Returns:

the newly created label

createLabel

public javax.swing.JLabel createLabel(java.lang.String textId,
                                      java.lang.String iconId,
                                      int pos,
                                      boolean isFullLine)

Creates a label via LabelFactory with the given ids and the given horizontal alignment. If the icon id is null, the label will be created also. The strings are the ids for the text in langpack and the icon in icons of the installer frame. If isFullLine true a LabelFactory.FullLineLabel will be created instead of a JLabel. The difference between both classes are a different layout handling.

Parameters:

textId - id string for the text

iconId - id string for the icon

pos - horizontal alignment

isFullLine - determines whether a FullLineLabel or a JLabel should be created

Returns:

the newly created label

createMultiLineLabelLang

public MultiLineLabel createMultiLineLabelLang(java.lang.String textId)

Creates a multi line label with the language dependent text given by the text id. The strings is the id for the text in langpack of the installer frame. The horizontal alignment will be LEFT.

Parameters:

textId - id string for the text

Returns:

the newly created multi line label

createMultiLineLabel

public MultiLineLabel createMultiLineLabel(java.lang.String text)

Creates a multi line label with the given text. The horizontal alignment will be LEFT.

Parameters:

text - text to be used in the label

Returns:

the newly created multi line label

createMultiLineLabel

public MultiLineLabel createMultiLineLabel(java.lang.String text,
                                           java.lang.String iconId,
                                           int pos)

Creates a label via LabelFactory with the given text, the given icon id and the given horizontal alignment. If the icon id is null, the label will be created also. The strings are the ids for the text in langpack and the icon in icons of the installer frame.

Parameters:

text - text to be used in the label

iconId - id string for the icon

pos - horizontal alignment

Returns:

the created multi line label

getControlTextFont

public java.awt.Font getControlTextFont()

The Font of Labels in many cases

getLAF

protected static javax.swing.plaf.metal.MetalLookAndFeel getLAF()

getDefaultGridBagConstraints

public java.awt.GridBagConstraints getDefaultGridBagConstraints()

Deprecated. use getLayoutHelper().getDefaulConstraints instead

Returns the default GridBagConstraints of this panel.

Returns:

the default GridBagConstraints of this panel

setDefaultGridBagConstraints

public void setDefaultGridBagConstraints(java.awt.GridBagConstraints constraints)

Deprecated. use getLayoutHelper().setDefaultConstraints instead

Sets the default GridBagConstraints of this panel to the given object.

Parameters:

constraints - which should be set as default for this object

resetGridCounter

public void resetGridCounter()

Deprecated. use getLayoutHelper().resetGridCounter instead

Resets the grid counters which are used at getNextXGridBagConstraints and getNextYGridBagConstraints.

getNewGridBagConstraints

public java.awt.GridBagConstraints getNewGridBagConstraints(int gridx,
                                                            int gridy)

Deprecated. use getLayoutHelper().getNewConstraints instead

Returns a newly created GridBagConstraints with the given values and the values from the defaultGridBagConstraints for the other parameters.

Parameters:

gridx - value to be used for the new constraint

gridy - value to be used for the new constraint

Returns:

newly created GridBagConstraints with the given values and the values from the defaultGridBagConstraints for the other parameters

getNewGridBagConstraints

public java.awt.GridBagConstraints getNewGridBagConstraints(int gridx,
                                                            int gridy,
                                                            int gridwidth,
                                                            int gridheight)

Deprecated. use getLayoutHelper().getNewConstraints instead

Returns a newly created GridBagConstraints with the given values and the values from the defaultGridBagConstraints for the other parameters.

Parameters:

gridx - value to be used for the new constraint

gridy - value to be used for the new constraint

gridwidth - value to be used for the new constraint

gridheight - value to be used for the new constraint

Returns:

newly created GridBagConstraints with the given values and the values from the defaultGridBagConstraints for the other parameters

getNextXGridBagConstraints

public java.awt.GridBagConstraints getNextXGridBagConstraints()

Deprecated. use getLayoutHelper().getNextXConstraints instead

Returns a newly created GridBagConstraints for the next column of the current layout row.

Returns:

a newly created GridBagConstraints for the next column of the current layout row

getNextYGridBagConstraints

public java.awt.GridBagConstraints getNextYGridBagConstraints()

Deprecated. use getLayoutHelper().getNextYConstraints instead

Returns a newly created GridBagConstraints with column 0 for the next row.

Returns:

a newly created GridBagConstraints with column 0 for the next row

getNextYGridBagConstraints

public java.awt.GridBagConstraints getNextYGridBagConstraints(int gridwidth,
                                                              int gridheight)

Deprecated. use getLayoutHelper().getNextYConstraints instead

Returns a newly created GridBagConstraints with column 0 for the next row using the given parameters.

Parameters:

gridwidth - width for this constraint

gridheight - height for this constraint

Returns:

a newly created GridBagConstraints with column 0 for the next row using the given parameters

startGridBagLayout

public void startGridBagLayout()

Deprecated. use getLayoutHelper().startLayout instead

Start layout determining. If it is needed, a dummy component will be created as first row. This will be done, if the IzPack guiprefs modifier with the key "layoutAnchor" has the value "SOUTH" or "SOUTHWEST". The earlier used value "BOTTOM" and the declaration via the IzPack variable IzPanel.LayoutType are also supported.

completeGridBagLayout

public void completeGridBagLayout()

Deprecated. use getLayoutHelper().completeLayout instead

Complete layout determining. If it is needed, a dummy component will be created as last row. This will be done, if the IzPack guiprefs modifier with the key "layoutAnchor" has the value "NORTH" or "NORTHWEST". The earlier used value "TOP" and the declaration via the IzPack variable IzPanel.LayoutType are also supported.

getSummaryBody

public java.lang.String getSummaryBody()

This method will be called from the SummaryPanel 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

public java.lang.String getSummaryCaption()

This method will be called from the SummaryPanel 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

isHidden

public boolean isHidden()

Returns whether this panel will be hidden general or not. A hidden panel will be not counted in the step counter and for panel icons.

Returns:

whether this panel will be hidden general or not

setHidden

public void setHidden(boolean hidden)

Set whether this panel should be hidden or not. A hidden panel will be not counted in the step counter and for panel icons.

Parameters:

hidden - flag to be set

getLayoutHelper

public LayoutHelper getLayoutHelper()

Returns the used layout helper. Can be used in a derived class to create custom layout.

Returns:

the used layout helper

getMetadata

public Panel getMetadata()

Returns:

the metadata

setMetadata

public void setMetadata(Panel p)

Parameters:

p - the metadata to set

getValidationService

public DataValidator getValidationService()

setValidationService

public void setValidationService(DataValidator validationService)

validatePanel

private final boolean validatePanel()

This method validates the field content. Validating is performed through a user supplied service class that provides the validation rules.

Returns:

true if the validation passes or no implementation of a validation rule exists. Otherwise false is returned.

parseText

protected java.lang.String parseText(java.lang.String string_to_parse)

Parses the text for special variables.

setHelps

public void setHelps(java.util.HashMap helps)

getHelpUrl

public java.lang.String getHelpUrl(java.lang.String isoCode)

canShowHelp

public boolean canShowHelp()

Indicates wether the panel can display help. The installer will hide Help button if current panel does not support help functions. Default behaviour is to return false.

Returns:

A boolean stating wether the panel supports Help function.

showHelp

public void showHelp()

This method is called when Help button has been clicked. By default it doesn't do anything.

getHelpWindow

private HelpWindow getHelpWindow()

addPreActivationAction

public void addPreActivationAction(PanelAction preActivateAction)

addPreValidationAction

public void addPreValidationAction(PanelAction preValidateAction)

addPostValidationAction

public void addPostValidationAction(PanelAction postValidateAction)

executePreActivationActions

protected final void executePreActivationActions()

executePreValidationActions

protected final void executePreValidationActions()

executePostValidationActions

protected final void executePostValidationActions()