|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JPanel
com.izforge.izpack.installer.IzPanel
public class IzPanel
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.
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.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 |
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. |
static int |
ROWS_1
ROWS_1 = 1 |
private static long |
serialVersionUID
|
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 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 | |
---|---|
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. |
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 |
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 |
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 |
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. |
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. |
boolean |
isValidated()
Indicates wether the panel has been validated or not. |
void |
makeXMLData(XMLElement 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. |
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 |
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 |
startGridBagLayout()
Deprecated. use getLayoutHelper().startLayout instead |
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, 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, 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 |
---|
private static final long serialVersionUID
protected LayoutHelper layoutHelper
protected java.awt.Component initialFocus
protected InstallData idata
protected InstallerFrame parent
protected java.lang.String myFullClassname
protected java.lang.String myClassname
protected java.lang.String myPrefix
protected java.lang.String headline
protected javax.swing.JLabel headLineLabel
protected boolean hidden
public static final java.lang.String HEADLINE
public static final int X_ORIGIN
public static final int Y_ORIGIN
public static final java.lang.String D
public static final java.lang.String d
public static final int COLS_1
public static final int ROWS_1
public Panel metadata
Constructor Detail |
---|
public IzPanel(InstallerFrame parent, InstallData idata)
parent
- The parent IzPack installer frame.idata
- The installer internal data.public IzPanel(InstallerFrame parent, InstallData idata, java.awt.LayoutManager2 lm)
parent
- The parent IzPack installer frame.idata
- The installer internal data.lm
- layout manager to be used with this IzPanelpublic IzPanel(InstallerFrame parent, InstallData idata, java.lang.String iconName)
parent
- the Parent Frameidata
- Installers Runtime Data SeticonName
- The Headline IconNamepublic IzPanel(InstallerFrame parent, InstallData idata, java.lang.String iconName, int instance)
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 counterMethod Detail |
---|
protected boolean buildHeadline(java.lang.String imageIconName, int instanceNumber)
imageIconName
- an IconnameinstanceNumber
- an panel instance
public java.lang.String getString(java.lang.String key)
key
- The Search key
public javax.swing.ImageIcon getImageIcon(java.lang.String iconName)
iconName
- a valid image icon
protected void initLayoutHelper()
protected void getClassName()
protected void init(InstallerFrame parent, InstallData idata)
parent
- the parent frameidata
- installers runtime datasetpublic boolean isValidated()
true
.
public void panelActivate()
public void panelDeactivate()
public void makeXMLData(XMLElement panelRoot)
panelRoot
- The XML root element of the panels blackbox tree.public int askQuestion(java.lang.String title, java.lang.String question, int choices)
askQuestion
in interface AbstractUIHandler
title
- Message title.question
- The question.choices
- The set of choices to present.
AbstractUIHandler.askQuestion(String, String, int)
public int askQuestion(java.lang.String title, java.lang.String question, int choices, int default_choice)
askQuestion
in interface AbstractUIHandler
title
- Message title.question
- The question.choices
- The set of choices to present.default_choice
- The default choice. (-1 = no default choice)
AbstractUIHandler.askQuestion(String, String, int, int)
public boolean emitNotificationFeedback(java.lang.String message)
public void emitNotification(java.lang.String message)
emitNotification
in interface AbstractUIHandler
message
- The notification.public boolean emitWarning(java.lang.String title, java.lang.String message)
emitWarning
in interface AbstractUIHandler
message
- The warning message.title
- The message title (used for dialog name, might not be displayed)
public void emitError(java.lang.String title, java.lang.String message)
emitError
in interface AbstractUIHandler
message
- The error message.title
- The message title (used for dialog name, might not be displayed)public java.awt.Component getInitialFocus()
public void setInitialFocus(java.awt.Component component)
component
- which should be get the focus at activation of this panelpublic java.lang.String getI18nStringForClass(java.lang.String subkey)
subkey
- the subkey for the string which should be returned
public java.lang.String getI18nStringForClass(java.lang.String subkey, java.lang.String alternateClass)
subkey
- the subkey for the string which should be returnedalternateClass
- the short name of the class which should be used if no string is
present with the runtime class name
private java.lang.String getI18nStringForClass(java.lang.String curClassName, java.lang.String subkey, java.lang.String alternateClass)
public InstallerFrame getInstallerFrame()
public javax.swing.JLabel createLabel(java.lang.String subkey, java.lang.String alternateClass, java.lang.String iconId, int pos)
subkey
- the subkey which should be used for resolving the textalternateClass
- the short name of the class which should be used if no string is
present with the runtime class nameiconId
- id string for the iconpos
- horizontal alignment
public javax.swing.JLabel createLabel(java.lang.String subkey, java.lang.String alternateClass, java.lang.String iconId, int pos, boolean isFullLine)
subkey
- the subkey which should be used for resolving the textalternateClass
- the short name of the class which should be used if no string is
present with the runtime class nameiconId
- id string for the iconpos
- horizontal alignmentisFullLine
- determines whether a FullLineLabel or a JLabel should be created
public javax.swing.JLabel createLabel(java.lang.String textId, java.lang.String iconId, int pos)
textId
- id string for the texticonId
- id string for the iconpos
- horizontal alignment
public javax.swing.JLabel createLabel(java.lang.String textId, java.lang.String iconId, int pos, boolean isFullLine)
textId
- id string for the texticonId
- id string for the iconpos
- horizontal alignmentisFullLine
- determines whether a FullLineLabel or a JLabel should be created
public MultiLineLabel createMultiLineLabelLang(java.lang.String textId)
textId
- id string for the text
public MultiLineLabel createMultiLineLabel(java.lang.String text)
text
- text to be used in the label
public MultiLineLabel createMultiLineLabel(java.lang.String text, java.lang.String iconId, int pos)
text
- text to be used in the labeliconId
- id string for the iconpos
- horizontal alignment
public java.awt.Font getControlTextFont()
protected static javax.swing.plaf.metal.MetalLookAndFeel getLAF()
public java.awt.GridBagConstraints getDefaultGridBagConstraints()
getLayoutHelper().getDefaulConstraints
instead
public void setDefaultGridBagConstraints(java.awt.GridBagConstraints constraints)
getLayoutHelper().setDefaultConstraints
instead
constraints
- which should be set as default for this objectpublic void resetGridCounter()
getLayoutHelper().resetGridCounter
instead
public java.awt.GridBagConstraints getNewGridBagConstraints(int gridx, int gridy)
getLayoutHelper().getNewConstraints
instead
gridx
- value to be used for the new constraintgridy
- value to be used for the new constraint
public java.awt.GridBagConstraints getNewGridBagConstraints(int gridx, int gridy, int gridwidth, int gridheight)
getLayoutHelper().getNewConstraints
instead
gridx
- value to be used for the new constraintgridy
- value to be used for the new constraintgridwidth
- value to be used for the new constraintgridheight
- value to be used for the new constraint
public java.awt.GridBagConstraints getNextXGridBagConstraints()
getLayoutHelper().getNextXConstraints
instead
public java.awt.GridBagConstraints getNextYGridBagConstraints()
getLayoutHelper().getNextYConstraints
instead
public java.awt.GridBagConstraints getNextYGridBagConstraints(int gridwidth, int gridheight)
getLayoutHelper().getNextYConstraints
instead
gridwidth
- width for this constraintgridheight
- height for this constraint
public void startGridBagLayout()
getLayoutHelper().startLayout
instead
IzPanel.LayoutType
are also supported.
public void completeGridBagLayout()
getLayoutHelper().completeLayout
instead
IzPanel.LayoutType
are also supported.
public java.lang.String getSummaryBody()
null
returns, no summary for this panel will be generated. Default behaviour is to return
null
.
public java.lang.String getSummaryCaption()
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>".
public boolean isHidden()
public void setHidden(boolean hidden)
hidden
- flag to be setpublic LayoutHelper getLayoutHelper()
public Panel getMetadata()
public void setMetadata(Panel p)
p
- the metadata to setprotected java.lang.String parseText(java.lang.String string_to_parse)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |