com.lf.commons.wizard.pgp

Class PGPKeyChooserPage

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.lf.commons.wizard.pgp.PGPKeyChooserPage

All Implemented Interfaces:

ConfigurableUnit, WizardPage, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public class PGPKeyChooserPage
extends javax.swing.JPanel
implements WizardPage, ConfigurableUnit

Configurable wizard tab to choose from a list of PGP keys.

Candidates may include keys with or without private/public key parts.

Since:

1.6

Version:

$Revision: 1.6 $, $Date: 2016/01/01 15:43:03 $

Author:

Axel Schwolow

See Also:

Serialized Form

Nested Class Summary

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

Fields

Modifier and Type	Field and Description
protected javax.swing.ImageIcon	icon The desired page icon.
protected static java.net.URL	IMAGE Default image.
protected WizardPage	nextPage Container with selection specific next pages.
protected java.lang.String	overviewText The text displayed by the overview.
protected WizardDialog	parent The parental dialog.
protected java.lang.String	title The text displayed as page title.

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 java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
PGPKeyChooserPage() Constructor of this form.

Method Summary

Methods

Modifier and Type	Method and Description
void	addKeySet(java.lang.String id, java.lang.String name, javax.swing.ImageIcon icon, com.didisoft.pgp.KeyPairInformation[] keyset) Adds a new key set to be displayed by the key set chooser.
void	configureUnit(java.lang.String id, Configuration config) Restores values from persistent data stores.
java.awt.Component	getComponent() Provides the GUI component to be displayed.
Configuration	getConfiguration() Provides the current user settings specified by user interaction.
javax.swing.ImageIcon	getIcon() Provides the graphical icon of the page used for display.
PGPKeyPanel	getKeyPanel() Returns the panel showing the keys.
WizardPage	getNextPage() Provides the next page to be displayed by the dialog.
java.lang.String	getOverviewText() Provides the text displayed by the overview (shorter than title).
WizardPage[]	getPossibleNextPages() Provides the set of pages that are possibly displayed next.
com.didisoft.pgp.KeyPairInformation	getSelectedKey() Returns the currently selected key from table.
com.didisoft.pgp.KeyPairInformation[]	getSelectedKeys() Returns the currently selected keys from table.
java.lang.String	getTitle() Provides the title of the page used for display.
boolean	isMultiSelectionEnabled() Provides the flag if multiple selection is enabled.
void	pageAdded(WizardDialog parent) Informs the wizard page that it will soon be used by the wizard dialog.
void	pageBecomesHidden() Informs the wizard page that it will be made invisible by the dialog.
void	pageBecomesShown() Informs the wizard page that it will be made visible by the dialog.
void	pageIsHiding() Informs the wizard page that it was made invisible by the wizard.
void	pageIsShowing() Informs the wizard page that it was made visible by the dialog.
void	reset() Removes the installed key sets and enters initial state again.
void	setIcon(javax.swing.ImageIcon icon) Sets the page icon.
void	setMultiSelectionEnabled(boolean enabled) Sets the flag if multiple selection is enabled.
void	setNextPage(WizardPage next) Sets the page to follow this page.
void	setOverviewText(java.lang.String text) Sets the short overview text.
void	setSelectedKey(com.didisoft.pgp.KeyPairInformation key) Sets the currently selected key.
void	setSelectedKeys(com.didisoft.pgp.KeyPairInformation[] keys) Sets the currently selected keys (multiple selection only).
void	setSelectedKeySet(java.lang.String id) Sets the currently selected key set.
void	setTextLabelKeySet(java.lang.String text) Overwrites the text displayed by the label next to the combo box chooser.
void	setTitle(java.lang.String title) Sets the title text (one single line).
void	storeUnit(java.lang.String id, Configuration config) Stores the current configuration values persistently.
void	unitRegistered(ApplicationModel model, java.lang.String id) Informs the configurable unit that it was registered with a model.
void	unitUnregistered(ApplicationModel model, java.lang.String id) Informs the configurable unit that it was unregistered with a model.
protected void	updateButtons() Updates the buttons based on the current selection.

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, isPaintingOrigin, 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, 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, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

IMAGE

protected static final java.net.URL IMAGE

Default image.

title

protected java.lang.String title

The text displayed as page title.

overviewText

protected java.lang.String overviewText

The text displayed by the overview.

icon

protected javax.swing.ImageIcon icon

The desired page icon.

parent

protected WizardDialog parent

The parental dialog.

nextPage

protected WizardPage nextPage

Container with selection specific next pages.

Constructor Detail

PGPKeyChooserPage

public PGPKeyChooserPage()

Constructor of this form.

Since:

1.6

Method Detail

getTitle

public java.lang.String getTitle()

Provides the title of the page used for display.

Specified by:

getTitle in interface WizardPage

Returns:

The page title

Since:

1.6

getOverviewText

public java.lang.String getOverviewText()

Provides the text displayed by the overview (shorter than title).

Specified by:

getOverviewText in interface WizardPage

Returns:

The overview text

Since:

1.6

getIcon

public javax.swing.ImageIcon getIcon()

Provides the graphical icon of the page used for display.

Specified by:

getIcon in interface WizardPage

Returns:

The page icon

Since:

1.6

getComponent

public java.awt.Component getComponent()

Provides the GUI component to be displayed.

Specified by:

getComponent in interface WizardPage

Returns:

The GUI component, normally the subclass itself

Since:

1.6

pageAdded

public void pageAdded(WizardDialog parent)

Informs the wizard page that it will soon be used by the wizard dialog.

Specified by:

pageAdded in interface WizardPage

Parameters:

parent - The wizard dialog

Since:

1.6

pageBecomesShown

public void pageBecomesShown()

Informs the wizard page that it will be made visible by the dialog.

Specified by:

pageBecomesShown in interface WizardPage

Since:

1.6

pageBecomesHidden

public void pageBecomesHidden()

Informs the wizard page that it will be made invisible by the dialog.

Specified by:

pageBecomesHidden in interface WizardPage

Since:

1.6

pageIsShowing

public void pageIsShowing()

Informs the wizard page that it was made visible by the dialog.

This is the right time to setup the dialog buttons as required. The "Back" button is set automatically depending on the pages on the stack before this method is called. The page can override the setting here.

Specified by:

pageIsShowing in interface WizardPage

Since:

1.6

pageIsHiding

public void pageIsHiding()

Informs the wizard page that it was made invisible by the wizard.

Specified by:

pageIsHiding in interface WizardPage

Since:

1.6

getNextPage

public WizardPage getNextPage()

Provides the next page to be displayed by the dialog.

Specified by:

getNextPage in interface WizardPage

Returns:

The next page to be shown, null means last page

Since:

1.6

getPossibleNextPages

public WizardPage[] getPossibleNextPages()

Provides the set of pages that are possibly displayed next.

The wizard class determines whether the page sequence is fixed or not. Fixed sequences allow the dialog to display the full overview containing all steps.

Specified by:

getPossibleNextPages in interface WizardPage

Returns:

The set of possible pages, null means last page

Since:

1.6

getConfiguration

public Configuration getConfiguration()

Provides the current user settings specified by user interaction.

The wizard calling routines can then perform actions based on the user settings.

Specified by:

getConfiguration in interface WizardPage

Returns:

The page settings

Since:

1.6

setTitle

public void setTitle(java.lang.String title)

Sets the title text (one single line).

Parameters:

title - The title text

Since:

1.6

setOverviewText

public void setOverviewText(java.lang.String text)

Sets the short overview text.

Parameters:

text - The overview text

Since:

1.6

setIcon

public void setIcon(javax.swing.ImageIcon icon)

Sets the page icon.

Parameters:

icon - The page icon

Since:

1.6

setNextPage

public void setNextPage(WizardPage next)

Sets the page to follow this page.

Specified by:

setNextPage in interface WizardPage

Parameters:

next - The next page if id is selected, null means finish

Since:

1.6

configureUnit

public void configureUnit(java.lang.String id,
                 Configuration config)

Restores values from persistent data stores.

Specified by:

configureUnit in interface ConfigurableUnit

Parameters:

id - The unique identifier for the instance

config - The configuration

Since:

1.6

storeUnit

public void storeUnit(java.lang.String id,
             Configuration config)

Stores the current configuration values persistently.

Specified by:

storeUnit in interface ConfigurableUnit

Parameters:

id - The unique identifier for the instance

config - The configuration

Since:

1.6

unitRegistered

public void unitRegistered(ApplicationModel model,
                  java.lang.String id)

Informs the configurable unit that it was registered with a model.

Specified by:

unitRegistered in interface ConfigurableUnit

Parameters:

model - The application model

id - The unique identifier for the instance

Since:

1.6

unitUnregistered

public void unitUnregistered(ApplicationModel model,
                    java.lang.String id)

Informs the configurable unit that it was unregistered with a model.

Specified by:

unitUnregistered in interface ConfigurableUnit

Parameters:

model - The application model

id - The unique identifier for the instance

Since:

1.6

setMultiSelectionEnabled

public void setMultiSelectionEnabled(boolean enabled)

Sets the flag if multiple selection is enabled.

Parameters:

enabled - Multiple selection enabled?

Since:

1.6

isMultiSelectionEnabled

public boolean isMultiSelectionEnabled()

Provides the flag if multiple selection is enabled.

Returns:

Multiple selection enabled?

Since:

1.6

getSelectedKeys

public com.didisoft.pgp.KeyPairInformation[] getSelectedKeys()

Returns the currently selected keys from table.

Returns:

Current table selection, zero-length if none is selected

Since:

1.6

setSelectedKeys

public void setSelectedKeys(com.didisoft.pgp.KeyPairInformation[] keys)

Sets the currently selected keys (multiple selection only).

Parameters:

keys - Desired selection

Since:

1.6

getSelectedKey

public com.didisoft.pgp.KeyPairInformation getSelectedKey()

Returns the currently selected key from table.

Returns:

Current table selection, may be null

Since:

1.6

setSelectedKey

public void setSelectedKey(com.didisoft.pgp.KeyPairInformation key)

Sets the currently selected key.

Parameters:

key - Desired selection

Since:

1.6

updateButtons

protected void updateButtons()

Updates the buttons based on the current selection.

Since:

1.6

addKeySet

public void addKeySet(java.lang.String id,
             java.lang.String name,
             javax.swing.ImageIcon icon,
             com.didisoft.pgp.KeyPairInformation[] keyset)

Adds a new key set to be displayed by the key set chooser.

Maybe you could use a unique connector identifier here.

Parameters:

id - The key set identifier, needs to be unique

name - The textual representation for the combo box

icon - The key set icon (optional)

keyset - The key candidates

Throws:

java.lang.NullPointerException - If a parameter is null

java.lang.IllegalArgumentException - If a parameter is invalid

Since:

1.6

setTextLabelKeySet

public void setTextLabelKeySet(java.lang.String text)

Overwrites the text displayed by the label next to the combo box chooser.

Parameters:

text - The text

Since:

1.6

reset

public void reset()

Removes the installed key sets and enters initial state again.

Since:

1.6

setSelectedKeySet

public void setSelectedKeySet(java.lang.String id)

Sets the currently selected key set.

Parameters:

id - The identifier of the key set

Throws:

java.lang.IllegalArgumentException - If a parameter is invalid

Since:

1.6

getKeyPanel

public PGPKeyPanel getKeyPanel()

Returns the panel showing the keys.

Returns:

Key panel

Since:

1.6