|
||||||||||
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.openswing.swing.miscellaneous.client.ProgressPanel
Title: OpenSwing Framework
Description: Panel that contains a progress bar and messages related to progress state.
Copyright: Copyright (C) 2006 Mauro Carniel
This file is part of OpenSwing Framework. This library is free software; you can redistribute it and/or modify it under the terms of the (LGPL) Lesser General Public License as published by the Free Software Foundation; GNU LESSER GENERAL PUBLIC LICENSE Version 2.1, February 1999 This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public License for more details. You should have received a copy of the GNU Library General Public License along with this library; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. The author may be contacted at: maurocarniel@tin.it
Nested Class Summary |
Nested classes inherited from class javax.swing.JComponent |
javax.swing.JComponent.AccessibleJComponent |
Field Summary |
Fields inherited from class javax.swing.JComponent |
TOOL_TIP_TEXT_KEY, 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 | |
ProgressPanel(java.lang.String mainTitle,
java.lang.String mainMessage,
java.lang.String[] messageLabels,
double minValue,
double maxValue,
boolean showCancelButton)
Constructor that can be used with any JFrame. |
Method Summary | |
void |
addCancelButtonListener(java.awt.event.ActionListener listener)
Add an action listener to the cancel button. |
boolean |
addColoredBand(double minValue,
double maxValue,
java.awt.Color color)
Add an interval [minValue,maxValue] and a color to use to paint that interval. |
java.lang.String |
getImageName()
|
double |
getMaximumValue()
|
double |
getMinimumValue()
|
java.awt.Color |
getProgressBarColor()
|
boolean |
isShowAllBands()
|
void |
processProgressEvent(ProgressEvent event)
Notify an event that will update the progress bar and the other window content. |
void |
removeCancelButtonListener(java.awt.event.ActionListener listener)
Remove the specified action listener to the cancel button. |
void |
setImageName(java.lang.String imageName)
Set an image panel a the left of the main title. |
void |
setMaximumValue(double maxValue)
Set the maximum value allowed in the progress bar. |
void |
setMinimumValue(double minValue)
Set the minimum value allowed in the progress bar. |
void |
setProgressBarColor(java.awt.Color color)
Set the progress bar color. |
void |
setShowAllBands(boolean showAllBands)
Determine how color the progress bar: true to paint the bar with many colors, each band with its color, false to paint the bar with ony one color: the color related to the last matched band. |
Methods inherited from class javax.swing.JPanel |
getAccessibleContext, getUI, getUIClassID, setUI, updateUI |
Methods inherited from class javax.swing.JComponent |
addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update |
Methods inherited from class java.awt.Container |
add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, 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, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, 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 |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public ProgressPanel(java.lang.String mainTitle, java.lang.String mainMessage, java.lang.String[] messageLabels, double minValue, double maxValue, boolean showCancelButton)
mainTitle
- main title (showed in BOLD style); this text will be automatically translate, according to ClientSettings contentmainMessage
- main message; this text will be automatically translate, according to ClientSettings contentmessageLabels
- list of label texts to set above the progress bar; this text will be automatically translate, according to ClientSettings contentminValue
- minimum value allowed in the progress barmaxValue
- maximum value allowed in the progress barMethod Detail |
public final void processProgressEvent(ProgressEvent event)
event
- progress eventpublic final void addCancelButtonListener(java.awt.event.ActionListener listener)
listener
- listener to addpublic final void removeCancelButtonListener(java.awt.event.ActionListener listener)
listener
- listener to removepublic final void setMinimumValue(double minValue)
minValue
- minimum value allowed in the progress barpublic final void setMaximumValue(double maxValue)
maxValue
- maximum value allowed in the progress barpublic final double getMinimumValue()
public final double getMaximumValue()
public final void setProgressBarColor(java.awt.Color color)
color
- progress bar colorpublic final java.awt.Color getProgressBarColor()
public final void setImageName(java.lang.String imageName)
imageName
- image name that identifies the image to show; the image must be located in "images" sub-folderpublic final java.lang.String getImageName()
public final boolean addColoredBand(double minValue, double maxValue, java.awt.Color color)
minValue
- minimum value of this intervalmaxValue
- maximum value of this intervalcolor
- color to use to paint this band
true
if the specified interval does not match any other interval, false
otherwisepublic final boolean isShowAllBands()
true
to paint the bar with many colors, each band with its color, false
to paint the bar with ony one color: the color related to the last matched bandpublic final void setShowAllBands(boolean showAllBands)
true
to paint the bar with many colors, each band with its color, false
to paint the bar with ony one color: the color related to the last matched band.
showAllBands
- flag used to determine how color the progress bar: true
to paint the bar with many colors, each band with its color, false
to paint the bar with ony one color: the color related to the last matched band
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |