com.lf.commons.dialog

Class RegisterDialog

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Dialog

javax.swing.JDialog

com.lf.commons.dialog.RegisterDialog

All Implemented Interfaces:

ConfigurableUnit, java.awt.event.ActionListener, java.awt.event.ItemListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.event.DocumentListener, javax.swing.RootPaneContainer, javax.swing.WindowConstants

public class RegisterDialog
extends javax.swing.JDialog
implements java.awt.event.ActionListener, ConfigurableUnit, javax.swing.event.DocumentListener, java.awt.event.ItemListener

Specialized dialog presenting the registration functionality to the user.

If applications are shippped on CD/DVD and sold by resellers like Amazon then an additional mechanism would make sense here. A new first tab "License Code" could be added where the user enters the Microsoft Windows-like code "E587f-..." and his personal licesee data. The data can then be submitted to a web service checking the license code. If the code has already been registered an error message is displayed. Via e-mail the registered user could be asked whether to release the license for the new user (e.g. ebay deal) or not. If the unique license code is unregistered (which should be the normal case), then the user gets the license key directly into the application and also via e-mail to safely store it for later use like it is common for Internet buys. The Windows XP license code is in the range of 30 (6*5) ^ 36 (A-Z0-9) possible codes which should be sufficient for our applications :-)

The given license manager should be a copy of the application's license manager in order to support cancel operation. The given license manager is loaded with data here and so an existing regular license will be overwritten. Only if the dialog was closed with "OK" and if the current license is valid the object should be activated for the application.

Since:

1.6

Version:

$Revision: 1.61 $, $Date: 2013/03/09 15:19:22 $

Author:

Axel Schwolow

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JDialog.AccessibleJDialog

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

java.awt.Dialog.AccessibleAWTDialog, java.awt.Dialog.ModalExclusionType, java.awt.Dialog.ModalityType

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

java.awt.Window.AccessibleAWTWindow, java.awt.Window.Type

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 byte[]	encryptedData The original raw license key data for restoration.
protected java.awt.event.HierarchyBoundsListener	resizeListener Displays the dimension if resized.

Fields inherited from class javax.swing.JDialog

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Dialog

DEFAULT_MODALITY_TYPE

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
RegisterDialog() Constructor method for the dialog (modeless).
RegisterDialog(java.awt.Dialog owner) Constructor method for the dialog.
RegisterDialog(java.awt.Frame owner) Constructor method for the dialog.

Method Summary

Methods

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent e) Reacts on component interaction.
void	allowEscapeOnKeyStroke(int strokeval) Adds a keyboard action to escape (close) the dialog (e.g. on escape).
void	changedUpdate(javax.swing.event.DocumentEvent e) Gives notification that an attribute or set of attributes changed.
void	configureUnit(java.lang.String id, Configuration config) Restores values from persistent data stores.
static AbstractDataSource[]	getCompleteLicenseInfo(byte[] encrypted, java.util.Properties props, Configuration config, Agreement[] agreements) Provides the license info to be used for the support data dialogs.
LicenseManager	getLicenseManager() Provides the license manager to use.
java.awt.Component	getTabComponent(java.lang.String tabtitle, AbstractDataSource content, boolean remove) Provides the tab component to be used from outside this class.
void	insertUpdate(javax.swing.event.DocumentEvent e) Gives notification that there was an insert into the document.
void	itemStateChanged(java.awt.event.ItemEvent e) Invoked when an item has been selected or deselected by the user.
void	removeUpdate(javax.swing.event.DocumentEvent e) Gives notification that a portion of the document has been removed.
void	setHelpID(java.lang.String helpid) Sets the optional help link to call the help system.
void	setLicenseManager(LicenseManager manager) Specifies the license manager to use.
void	setVisible(boolean visible) Activates or deactivates the dialog.
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.

Methods inherited from class javax.swing.JDialog

addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Dialog

addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setBackground, setModal, setModalityType, setOpacity, setResizable, setShape, setTitle, setUndecorated, show, toBack

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setName, setPreferredSize, 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

encryptedData

protected byte[] encryptedData

The original raw license key data for restoration.

resizeListener

protected java.awt.event.HierarchyBoundsListener resizeListener

Displays the dimension if resized.

Constructor Detail

RegisterDialog

public RegisterDialog()

Constructor method for the dialog (modeless).

Since:

1.6

RegisterDialog

public RegisterDialog(java.awt.Frame owner)

Constructor method for the dialog.

Parameters:

owner - The owner frame

Since:

1.6

RegisterDialog

public RegisterDialog(java.awt.Dialog owner)

Constructor method for the dialog.

Parameters:

owner - The owner dialog

Since:

1.6

Method Detail

setLicenseManager

public void setLicenseManager(LicenseManager manager)

Specifies the license manager to use.

Parameters:

manager - The license manager

Throws:

java.lang.NullPointerException - If the manager is null

Since:

1.6

getLicenseManager

public LicenseManager getLicenseManager()

Provides the license manager to use.

Returns:

The license manager or null if unchanged

Since:

1.6

allowEscapeOnKeyStroke

public void allowEscapeOnKeyStroke(int strokeval)

Adds a keyboard action to escape (close) the dialog (e.g. on escape).

The dialog is not disposed here since it may be recycled by an application.

Parameters:

strokeval - The desired escape key stroke like KeyEvent.VK_ESCAPE

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

setHelpID

public void setHelpID(java.lang.String helpid)

Sets the optional help link to call the help system.

Parameters:

helpid - The help system link

Since:

1.6

getCompleteLicenseInfo

public static AbstractDataSource[] getCompleteLicenseInfo(byte[] encrypted,
                                          java.util.Properties props,
                                          Configuration config,
                                          Agreement[] agreements)

Provides the license info to be used for the support data dialogs.

This should be overwritten by subclasses to adjust the provided pieces of license info. By default this method creates data sources for all available data portions shown by the RegisterDialog. Only the English agreement is provided if available.

Parameters:

encrypted - The encrypted license (optional)

props - The properties

config - The config

agreements - The agreements

Returns:

The data sources, may have zero-length

Since:

1.6

See Also:

(int, DataSource)

getTabComponent

public java.awt.Component getTabComponent(java.lang.String tabtitle,
                                 AbstractDataSource content,
                                 boolean remove)

Provides the tab component to be used from outside this class.

The component is removed and cannot be used here any longer. This method is to recycle existing components and to save creating unnecessary classes. The desired panel can be loaded with content as it is required by the SupportDataViewer class.

Parameters:

tabtitle - Title of the tab

content - The content to load (optional)

remove - Remove component?

Returns:

The tab component, may be null

Throws:

java.lang.IllegalArgumentException - If parameters are invalid

Since:

1.6

See Also:

(LicenseManager)

setVisible

public void setVisible(boolean visible)

Activates or deactivates the dialog.

Overrides:

setVisible in class java.awt.Dialog

Parameters:

visible - The state of the dialog

Since:

1.6

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)

Reacts on component interaction.

Specified by:

actionPerformed in interface java.awt.event.ActionListener

Parameters:

e - Event to be processed

Since:

1.6

changedUpdate

public void changedUpdate(javax.swing.event.DocumentEvent e)

Gives notification that an attribute or set of attributes changed.

Specified by:

changedUpdate in interface javax.swing.event.DocumentListener

Parameters:

e - Event object reference

Since:

1.5

insertUpdate

public void insertUpdate(javax.swing.event.DocumentEvent e)

Gives notification that there was an insert into the document.

Specified by:

insertUpdate in interface javax.swing.event.DocumentListener

Parameters:

e - Event object reference

Since:

1.5

removeUpdate

public void removeUpdate(javax.swing.event.DocumentEvent e)

Gives notification that a portion of the document has been removed.

Specified by:

removeUpdate in interface javax.swing.event.DocumentListener

Parameters:

e - Event object reference

Since:

1.5

itemStateChanged

public void itemStateChanged(java.awt.event.ItemEvent e)

Invoked when an item has been selected or deselected by the user.

Specified by:

itemStateChanged in interface java.awt.event.ItemListener

Parameters:

e - Event object reference

Since:

1.5