|
|||||||||
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
org.brains2b.swingext.dialog.AboutPane
public class AboutPane
This class opens an standard About dialog which you can fill through your application and will be layed out by the About Dialog itself
The AboutDialog further acts as a default JDialog
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.BltBufferStrategy, java.awt.Component.FlipBufferStrategy |
Field Summary |
---|
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 | |
---|---|
AboutPane()
Constructor for AboutDialog |
|
AboutPane(java.util.Properties prop)
Constructor for AboutDialog. |
Method Summary | |
---|---|
void |
addContributor(java.lang.String logoFile,
java.lang.String text)
adds a Contributor to an aboutbox. |
void |
addContributorFile(java.lang.String logoFile,
java.lang.String textFile)
adds a Contributor to an aboutbox. |
java.awt.Dimension |
getPreferredSize()
|
void |
setAuthor(java.lang.String author)
sets the name of the person or organisation that made the application |
void |
setDate(java.lang.String date)
sets the date of the current application |
void |
setLogo(java.lang.String fileName)
sets the logo by reading the fileName as resource. |
void |
setLogo(java.lang.String fileName,
boolean border)
sets the logo by reading the fileName as resource. |
void |
setText(java.lang.String text)
sets the text of this about box, can be a license or anything else you want to tell the user. |
void |
setTextfromFile(java.lang.String fileName)
sets the text for this application to be read from a resource file. |
void |
setTitle(java.lang.String title)
Sets the title of the application Also sets the title of the Window including the word About. |
void |
setVersion(java.lang.String version)
sets the current version of the application |
static void |
showDialog(java.awt.Component parent)
|
static void |
showInternalDialog(java.awt.Component parent,
java.lang.String title,
javax.swing.Icon icon)
|
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, 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 |
Constructor Detail |
---|
public AboutPane()
Dialog.Dialog(Frame, boolean)
public AboutPane(java.util.Properties prop)
WARNING: This function is not implemented yet. It is however not removed while some old applications still rely on it.
prop
- java.util.Properties properties containing values for
initializing the About DialogDialog.Dialog(Frame, boolean)
Method Detail |
---|
public java.awt.Dimension getPreferredSize()
getPreferredSize
in class javax.swing.JComponent
public void setLogo(java.lang.String fileName)
fileName
- String,
the name of the file which needs to be in the classpathpublic void setLogo(java.lang.String fileName, boolean border)
fileName
- String,
the name of the file which needs to be in the classpathborder
- boolean, true if you want to draw a border around the logopublic void setTitle(java.lang.String title)
Also sets the title of the Window including the word About.
Dialog.setTitle(String)
public void setVersion(java.lang.String version)
version
- String, a freeformat String to describe the version.public void setDate(java.lang.String date)
date
- String , a freeformat String to describe the date.public void setAuthor(java.lang.String author)
author
- String, a freeformat String to describe the author of the
applicationpublic void setText(java.lang.String text)
You might prefer setTextfromFile if the text is long.
text
- String, the text you want displayed in this application.public void setTextfromFile(java.lang.String fileName) throws java.io.IOException
The file is read and displayed line by line. So be sure you have carriage returns in you text where appropriate, otherwise it might be all garbaled up on screen.
fileName
- String, the name of the file to be read as resource. This
needs to be found in the classpath of the application.
IOException,
- thrown if the file cannot be found or accessed.
java.io.IOException
public void addContributor(java.lang.String logoFile, java.lang.String text)
logoFile
- String, the name of the file to be read as resource. This
needs to be found in the classpath of the application.text
- String, a possible multi-line text with text possibly the
license of the contributorpublic void addContributorFile(java.lang.String logoFile, java.lang.String textFile) throws java.io.IOException
logoFile
- String, the name of the file to be read as resource. This
needs to be found in the classpath of the application.textFile
- String, the name of the file to be read as resource. This can
be a possible multi-line text with text possibly the license
of the contributor
IOException,
- thrown if the textFile cannot be found or accessed. remember
the logoFile is optional
java.io.IOException
public static void showDialog(java.awt.Component parent)
public static void showInternalDialog(java.awt.Component parent, java.lang.String title, javax.swing.Icon icon)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |