JHelp
Class JLicenseDialog

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--java.awt.Window
                    |
                    +--java.awt.Dialog
                          |
                          +--javax.swing.JDialog
                                |
                                +--JHelp.JLicenseDialog
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, javax.swing.RootPaneContainer, java.io.Serializable, javax.swing.WindowConstants

public class JLicenseDialog
extends javax.swing.JDialog

This class is the Dialog that displays a license agreement.

Example:

 // 'this' is a Frame parent object that implements JLicenseListener
 JLicenseDialog licenseDialog = new JLicenseDialog(this, "license.html", this);
 licenseDialog.centerDialog();
 licenseDialog.setVisible(true);
 

Copyright (c) 2003

Document Date: 7/03

Company: Vermalt LLC

See Also:
Serialized Form

Field Summary
 
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
JLicenseDialog(JLicenseListener jLicenseListener, java.io.File file)
          Construct a JLicenseDialog.
JLicenseDialog(JLicenseListener jLicenseListener, java.io.File file, java.awt.Frame owner)
          Construct a JLicenseDialog.
 
Method Summary
 void centerDialog()
          Center this dialog on the screen.
 javax.swing.JButton getAcceptButton()
          Get the JButton used for the accept button.
 javax.swing.JLabel getAcceptQuestionLabel()
          Get the JLabel used for the accept question.
 javax.swing.JButton getExitButton()
          Get the JButton used for the exit button.
 javax.swing.JEditorPane getJEditorPane()
          Get the JEditorPane for displaying the license.
 javax.swing.JCheckBox getYesCheckbox()
          Get the JCheckBox used for the Yes confirmation.
 void setAcceptIcon(javax.swing.Icon icon)
          Set the icon to display in the Accept button.
 void setAgreementFont(java.awt.Font f)
          Set the font to use for the accept question and Yes checkbox.
 void setCharset(java.lang.String charset)
           
 void setExitIcon(javax.swing.Icon icon)
          Set the icon to display in the Exit button.
 
Methods inherited from class javax.swing.JDialog
getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isDefaultLookAndFeelDecorated, remove, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, update
 
Methods inherited from class java.awt.Dialog
addNotify, dispose, getTitle, hide, isModal, isResizable, isUndecorated, setModal, setResizable, setTitle, setUndecorated, show
 
Methods inherited from class java.awt.Window
addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, isActive, isFocusableWindow, isFocusCycleRoot, isFocused, isShowing, pack, postEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationRelativeTo, toBack, 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, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, remove, removeAll, removeContainerListener, removeNotify, setFocusTraversalKeys, setFocusTraversalPolicy, setFont, transferFocusBackward, transferFocusDownCycle, validate
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, dispatchEvent, enable, enable, enableInputMethods, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, 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, isOpaque, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

JLicenseDialog

public JLicenseDialog(JLicenseListener jLicenseListener,
                      java.io.File file)

Construct a JLicenseDialog.

Parameters:
jLicenseListener - The listener to detect the accept or exit
file - The file containing the license

JLicenseDialog

public JLicenseDialog(JLicenseListener jLicenseListener,
                      java.io.File file,
                      java.awt.Frame owner)

Construct a JLicenseDialog.

Parameters:
jLicenseListener - The listener to detect the accept or exit
file - The file containing the license
owner - The parent owner Frame
Method Detail

centerDialog

public void centerDialog()

Center this dialog on the screen.


getAcceptButton

public javax.swing.JButton getAcceptButton()

Get the JButton used for the accept button.


getAcceptQuestionLabel

public javax.swing.JLabel getAcceptQuestionLabel()

Get the JLabel used for the accept question.


getExitButton

public javax.swing.JButton getExitButton()

Get the JButton used for the exit button.


getJEditorPane

public javax.swing.JEditorPane getJEditorPane()

Get the JEditorPane for displaying the license.


getYesCheckbox

public javax.swing.JCheckBox getYesCheckbox()

Get the JCheckBox used for the Yes confirmation.


setAcceptIcon

public void setAcceptIcon(javax.swing.Icon icon)

Set the icon to display in the Accept button.

Parameters:
icon - The icon to display.

setAgreementFont

public void setAgreementFont(java.awt.Font f)

Set the font to use for the accept question and Yes checkbox.

Parameters:
f - Font

setCharset

public void setCharset(java.lang.String charset)

setExitIcon

public void setExitIcon(javax.swing.Icon icon)

Set the icon to display in the Exit button.

Parameters:
icon - The icon to display.