org.xnap.commons.gui
Class AboutDialog

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Dialog
                  javax.swing.JDialog
                      org.xnap.commons.gui.DefaultDialog
                          org.xnap.commons.gui.AboutDialog

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants

public class AboutDialog
extends DefaultDialog

Simple about dialog. A JTabbedPane is used as the main widget and methods are provided to add tabs that contain a file, e.g. the software license.

See Also:

Serialized Form

Nested Class Summary

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

JDialog.AccessibleJDialog

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

Dialog.AccessibleAWTDialog

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

Window.AccessibleAWTWindow

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

Container.AccessibleAWTContainer

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

Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields inherited from class org.xnap.commons.gui.DefaultDialog

BUTTON_APPLY, BUTTON_CANCEL, BUTTON_CLOSE, BUTTON_CONTEXT_HELP, BUTTON_DEFAULTS, BUTTON_HELP, BUTTON_NONE, BUTTON_OKAY, isOkay

Fields inherited from class javax.swing.JDialog

accessibleContext, rootPane, rootPaneCheckingEnabled

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

AboutDialog()
Constructs an empty dialog with a single close button.

AboutDialog(JDialog owner)
Constructs an empty dialog with a single close button.

AboutDialog(JFrame owner)
Constructs an empty dialog with a single close button.

Method Summary

JEditorPane	addHTMLTab(String title, String filename, boolean followHyperlinks)
JEditorPane	addHTMLTab(String title, String filename, String alternativeMessage, boolean closeable, boolean followHyperlinks)
JTextArea	addLogoTab(String title, Icon image, String filename) Adds a tab that displays an image that is followed by a file's content.
JTextArea	addLogoTab(String title, Icon image, String filename, String alternativeMessage, boolean closeable) Adds a tab that displays an image that is followed by a file's content.
JTextArea	addTab(String title, String filename) Adds a tab that displays a file's content.
JTextArea	addTab(String title, String filename, String alternativeMessage, boolean closeable) Adds a tab that displays a file's content.
String	getFileNotFoundMessage(String filename)
Component	getOrAddTab(String name, String filename) Adds a new license tab.
CloseableTabbedPane	getTabbedPane() Returns the main widget.

Methods inherited from class org.xnap.commons.gui.DefaultDialog

apply, cancelled, close, contextHelp, defaults, getApplyAction, getButtonPanel, getCancelAction, getCloseAction, getContextHelpAction, getDefaultsAction, getHelpAction, getMainPanel, getOkayAction, getTopPanel, help, isOkay, setApplyOnEnter, setButtonSeparatorVisible, setMainComponent, show

Methods inherited from class javax.swing.JDialog

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

Methods inherited from class java.awt.Dialog

addNotify, 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, dispose, finalize, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, isActive, isAlwaysOnTop, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setAlwaysOnTop, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationByPlatform, 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, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, removeNotify, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, 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, 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, isOpaque, 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, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

AboutDialog

public AboutDialog(JDialog owner)

Constructs an empty dialog with a single close button.

Parameters:

owner - the dialog owner

AboutDialog

public AboutDialog(JFrame owner)

Constructs an empty dialog with a single close button.

Parameters:

owner - the dialog owner

AboutDialog

public AboutDialog()

Constructs an empty dialog with a single close button.

Method Detail

addLogoTab

public JTextArea addLogoTab(String title,
                            Icon image,
                            String filename,
                            String alternativeMessage,
                            boolean closeable)

Adds a tab that displays an image that is followed by a file's content.

Parameters:

title - the title of the tab

image - the image

filename - the name of the file to display

alternativeMessage - the text that is displayed if filename can not be read

Returns:

the text area that was added to the created tab

See Also:

GUIHelper.showFile(JTextComponent, String, String)

addLogoTab

public JTextArea addLogoTab(String title,
                            Icon image,
                            String filename)

Adds a tab that displays an image that is followed by a file's content.

Parameters:

title - the title of the tab

image - the image

filename - the name of the file to display

Returns:

the text area that was added to the created tab

See Also:

addLogoTab(String, Icon, String, String, boolean)

addTab

public JTextArea addTab(String title,
                        String filename,
                        String alternativeMessage,
                        boolean closeable)

Adds a tab that displays a file's content.

Parameters:

title - the title of the tab

filename - the name of the file to display

alternativeMessage - the text that is displayed if filename can not be read

Returns:

the text area that was added to the created tab

See Also:

GUIHelper.showFile(JTextComponent, String, String)

addTab

public JTextArea addTab(String title,
                        String filename)

Adds a tab that displays a file's content.

Parameters:

title - the title of the tab

filename - the name of the file to display

Returns:

the text area that was added to the created tab

See Also:

addTab(String, String, String, boolean)

addHTMLTab

public JEditorPane addHTMLTab(String title,
                              String filename,
                              String alternativeMessage,
                              boolean closeable,
                              boolean followHyperlinks)

addHTMLTab

public JEditorPane addHTMLTab(String title,
                              String filename,
                              boolean followHyperlinks)

getTabbedPane

public CloseableTabbedPane getTabbedPane()

Returns the main widget.

getFileNotFoundMessage

public String getFileNotFoundMessage(String filename)

getOrAddTab

public Component getOrAddTab(String name,
                             String filename)

Adds a new license tab. License files are supposed to be pure text files.

Parameters:

name - of the license

filename - filename of the license text to load