| javax.swing.JComponent
 chatserver.client.InfiniteProgressPanel
| InfiniteProgressPanel | | public class InfiniteProgressPanel extends JComponent implements MouseListener(Code) | | An infinite progress panel displays a rotating figure and
a message to notice the user of a long, duration unknown
task. The shape and the text are drawn upon a white veil
which alpha level (or shield value) lets the underlying
component shine through. This panel is meant to be used
asa glass pane in the window performing the long
operation.
On the contrary to regular glass panes, you don't need to
set it visible or not by yourself. Once you've started the
animation all the mouse events are intercepted by this
panel, preventing them from being forwared to the
underlying components.
The panel can be controlled by the start(),
stop() and interrupt() methods.
Example:
InfiniteProgressPanel pane = new InfiniteProgressPanel();
frame.setGlassPane(pane);
pane.start()
Several properties can be configured at creation time. The
message and its font can be changed at runtime. Changing the
font can be done using setFont() and
setForeground().
Code from Romain Guy's webblog - http://www.jroller.com/page/gfx (BSD license.)
author:
Romain Guy
version:
1.0 |
| Field Summary | |
| protected int | alphaLevel
Alpha level of the veil, used for fade in/out. | | protected Thread | animation
The animation thread is responsible for fade in/out and rotation. | | protected int | barsCount
Amount of bars composing the circular shape. | | protected float | fps
Amount of frames per seconde. | | protected RenderingHints | hints
Rendering hints to set anti aliasing. | | protected int | rampDelay
Duration of the veil's fade in/out. | | protected float | shield
Alpha level of the veil. | | protected boolean | started
Notifies whether the animation is running or not. | | protected String | text
Message displayed below the circular shape. | | protected Area[] | ticker
Contains the bars composing the circular shape. |
| Constructor Summary | |
| public | InfiniteProgressPanel()
| | public | InfiniteProgressPanel(String text)
Creates a new progress panel with default values:
- 14 bars
- Veil's alpha level is 70%
- 15 frames per second
- Fade in/out last 300 ms
Parameters:
text - The message to be displayed. | | public | InfiniteProgressPanel(String text, int barsCount)
Creates a new progress panel with default values:
- Veil's alpha level is 70%
- 15 frames per second
- Fade in/out last 300 ms
Parameters:
text - The message to be displayed. | | public | InfiniteProgressPanel(String text, int barsCount, float shield)
Creates a new progress panel with default values:
- 15 frames per second
- Fade in/out last 300 ms
Parameters:
text - The message to be displayed. | | public | InfiniteProgressPanel(String text, int barsCount, float shield, float fps)
Creates a new progress panel with default values:
Parameters:
text - The message to be displayed. | | public | InfiniteProgressPanel(String text, int barsCount, float shield, float fps, int rampDelay)
Creates a new progress panel.
Parameters:
text - The message to be displayed. |
| alphaLevel | | protected int alphaLevel(Code) | | Alpha level of the veil, used for fade in/out.
|
| animation | | protected Thread animation(Code) | | The animation thread is responsible for fade in/out and rotation.
|
| barsCount | | protected int barsCount(Code) | | Amount of bars composing the circular shape.
|
| fps | | protected float fps(Code) | | Amount of frames per seconde. Lowers this to save CPU.
|
| rampDelay | | protected int rampDelay(Code) | | Duration of the veil's fade in/out.
|
| shield | | protected float shield(Code) | | Alpha level of the veil.
|
| started | | protected boolean started(Code) | | Notifies whether the animation is running or not.
|
| text | | protected String text(Code) | | Message displayed below the circular shape.
|
| ticker | | protected Area[] ticker(Code) | | Contains the bars composing the circular shape.
|
| InfiniteProgressPanel | | public InfiniteProgressPanel()(Code) | | Creates a new progress panel with default values:
- No message
- 14 bars
- Veil's alpha level is 70%
- 15 frames per second
- Fade in/out last 300 ms
|
| InfiniteProgressPanel | | public InfiniteProgressPanel(String text)(Code) | | Creates a new progress panel with default values:
- 14 bars
- Veil's alpha level is 70%
- 15 frames per second
- Fade in/out last 300 ms
Parameters:
text - The message to be displayed. Can be null or empty. |
| InfiniteProgressPanel | | public InfiniteProgressPanel(String text, int barsCount)(Code) | | Creates a new progress panel with default values:
- Veil's alpha level is 70%
- 15 frames per second
- Fade in/out last 300 ms
Parameters:
text - The message to be displayed. Can be null or empty.
Parameters:
barsCount - The amount of bars composing the circular shape |
| InfiniteProgressPanel | | public InfiniteProgressPanel(String text, int barsCount, float shield)(Code) | | Creates a new progress panel with default values:
- 15 frames per second
- Fade in/out last 300 ms
Parameters:
text - The message to be displayed. Can be null or empty.
Parameters:
barsCount - The amount of bars composing the circular shape.
Parameters:
shield - The alpha level between 0.0 and 1.0 of the coloredshield (or veil). |
| InfiniteProgressPanel | | public InfiniteProgressPanel(String text, int barsCount, float shield, float fps)(Code) | | Creates a new progress panel with default values:
Parameters:
text - The message to be displayed. Can be null or empty.
Parameters:
barsCount - The amount of bars composing the circular shape.
Parameters:
shield - The alpha level between 0.0 and 1.0 of the coloredshield (or veil).
Parameters:
fps - The number of frames per second. Lower this value todecrease CPU usage. |
| InfiniteProgressPanel | | public InfiniteProgressPanel(String text, int barsCount, float shield, float fps, int rampDelay)(Code) | | Creates a new progress panel.
Parameters:
text - The message to be displayed. Can be null or empty.
Parameters:
barsCount - The amount of bars composing the circular shape.
Parameters:
shield - The alpha level between 0.0 and 1.0 of the coloredshield (or veil).
Parameters:
fps - The number of frames per second. Lower this value todecrease CPU usage.
Parameters:
rampDelay - The duration, in milli seconds, of the fade in andthe fade out of the veil. |
| getText | | public String getText()(Code) | | Returns the current displayed message.
|
| interrupt | | public void interrupt()(Code) | | Interrupts the animation, whatever its state is. You
can use it when you need to stop the animation without
running the fade out phase.
This methods sets the panel invisible at the end.
|
| setText | | public void setText(String text)(Code) | | Changes the displayed message at runtime.
Parameters:
text - The message to be displayed. Can be null or empty. |
| start | | public void start()(Code) | | Starts the waiting animation by fading the veil in, then
rotating the shapes. This method handles the visibility
of the glass pane.
|
| stop | | public void stop()(Code) | | Stops the waiting animation by stopping the rotation
of the circular shape and then by fading out the veil.
This methods sets the panel invisible at the end.
|
| Methods inherited from javax.swing.JComponent | public void addAncestorListener(AncestorListener listener)(Code)(Java Doc)
public void addNotify()(Code)(Java Doc)
public synchronized void addVetoableChangeListener(VetoableChangeListener listener)(Code)(Java Doc)
public void computeVisibleRect(Rectangle visibleRect)(Code)(Java Doc)
public boolean contains(int x, int y)(Code)(Java Doc)
public JToolTip createToolTip()(Code)(Java Doc)
public void disable()(Code)(Java Doc)
public void enable()(Code)(Java Doc)
public void firePropertyChange(String propertyName, boolean oldValue, boolean newValue)(Code)(Java Doc)
public void firePropertyChange(String propertyName, int oldValue, int newValue)(Code)(Java Doc)
public void firePropertyChange(String propertyName, char oldValue, char newValue)(Code)(Java Doc)
protected void fireVetoableChange(String propertyName, Object oldValue, Object newValue) throws java.beans.PropertyVetoException(Code)(Java Doc)
public AccessibleContext getAccessibleContext()(Code)(Java Doc)
public ActionListener getActionForKeyStroke(KeyStroke aKeyStroke)(Code)(Java Doc)
final public ActionMap getActionMap()(Code)(Java Doc)
public float getAlignmentX()(Code)(Java Doc)
public float getAlignmentY()(Code)(Java Doc)
public AncestorListener[] getAncestorListeners()(Code)(Java Doc)
public boolean getAutoscrolls()(Code)(Java Doc)
public int getBaseline(int width, int height)(Code)(Java Doc)
public BaselineResizeBehavior getBaselineResizeBehavior()(Code)(Java Doc)
public Border getBorder()(Code)(Java Doc)
public Rectangle getBounds(Rectangle rv)(Code)(Java Doc)
final public Object getClientProperty(Object key)(Code)(Java Doc)
protected Graphics getComponentGraphics(Graphics g)(Code)(Java Doc)
public JPopupMenu getComponentPopupMenu()(Code)(Java Doc)
public int getConditionForKeyStroke(KeyStroke aKeyStroke)(Code)(Java Doc)
public int getDebugGraphicsOptions()(Code)(Java Doc)
public static Locale getDefaultLocale()(Code)(Java Doc)
public FontMetrics getFontMetrics(Font font)(Code)(Java Doc)
public Graphics getGraphics()(Code)(Java Doc)
public int getHeight()(Code)(Java Doc)
public boolean getInheritsPopupMenu()(Code)(Java Doc)
final public InputMap getInputMap(int condition)(Code)(Java Doc)
final public InputMap getInputMap()(Code)(Java Doc)
public InputVerifier getInputVerifier()(Code)(Java Doc)
public Insets getInsets()(Code)(Java Doc)
public Insets getInsets(Insets insets)(Code)(Java Doc)
public T[] getListeners(Class<T> listenerType)(Code)(Java Doc)
public Point getLocation(Point rv)(Code)(Java Doc)
public Dimension getMaximumSize()(Code)(Java Doc)
public Dimension getMinimumSize()(Code)(Java Doc)
public Component getNextFocusableComponent()(Code)(Java Doc)
public Point getPopupLocation(MouseEvent event)(Code)(Java Doc)
public Dimension getPreferredSize()(Code)(Java Doc)
public KeyStroke[] getRegisteredKeyStrokes()(Code)(Java Doc)
public JRootPane getRootPane()(Code)(Java Doc)
public Dimension getSize(Dimension rv)(Code)(Java Doc)
public Point getToolTipLocation(MouseEvent event)(Code)(Java Doc)
public String getToolTipText()(Code)(Java Doc)
public String getToolTipText(MouseEvent event)(Code)(Java Doc)
public Container getTopLevelAncestor()(Code)(Java Doc)
public TransferHandler getTransferHandler()(Code)(Java Doc)
public String getUIClassID()(Code)(Java Doc)
public boolean getVerifyInputWhenFocusTarget()(Code)(Java Doc)
public synchronized VetoableChangeListener[] getVetoableChangeListeners()(Code)(Java Doc)
public Rectangle getVisibleRect()(Code)(Java Doc)
public int getWidth()(Code)(Java Doc)
public int getX()(Code)(Java Doc)
public int getY()(Code)(Java Doc)
public void grabFocus()(Code)(Java Doc)
public boolean isDoubleBuffered()(Code)(Java Doc)
public static boolean isLightweightComponent(Component c)(Code)(Java Doc)
public boolean isManagingFocus()(Code)(Java Doc)
public boolean isOpaque()(Code)(Java Doc)
public boolean isOptimizedDrawingEnabled()(Code)(Java Doc)
final public boolean isPaintingForPrint()(Code)(Java Doc)
public boolean isPaintingTile()(Code)(Java Doc)
public boolean isRequestFocusEnabled()(Code)(Java Doc)
public boolean isValidateRoot()(Code)(Java Doc)
public void paint(Graphics g)(Code)(Java Doc)
protected void paintBorder(Graphics g)(Code)(Java Doc)
protected void paintChildren(Graphics g)(Code)(Java Doc)
protected void paintComponent(Graphics g)(Code)(Java Doc)
public void paintImmediately(int x, int y, int w, int h)(Code)(Java Doc)
public void paintImmediately(Rectangle r)(Code)(Java Doc)
protected String paramString()(Code)(Java Doc)
public void print(Graphics g)(Code)(Java Doc)
public void printAll(Graphics g)(Code)(Java Doc)
protected void printBorder(Graphics g)(Code)(Java Doc)
protected void printChildren(Graphics g)(Code)(Java Doc)
protected void printComponent(Graphics g)(Code)(Java Doc)
protected void processComponentKeyEvent(KeyEvent e)(Code)(Java Doc)
protected boolean processKeyBinding(KeyStroke ks, KeyEvent e, int condition, boolean pressed)(Code)(Java Doc)
protected void processKeyEvent(KeyEvent e)(Code)(Java Doc)
protected void processMouseEvent(MouseEvent e)(Code)(Java Doc)
protected void processMouseMotionEvent(MouseEvent e)(Code)(Java Doc)
final public void putClientProperty(Object key, Object value)(Code)(Java Doc)
public void registerKeyboardAction(ActionListener anAction, String aCommand, KeyStroke aKeyStroke, int aCondition)(Code)(Java Doc)
public void registerKeyboardAction(ActionListener anAction, KeyStroke aKeyStroke, int aCondition)(Code)(Java Doc)
public void removeAncestorListener(AncestorListener listener)(Code)(Java Doc)
public void removeNotify()(Code)(Java Doc)
public synchronized void removeVetoableChangeListener(VetoableChangeListener listener)(Code)(Java Doc)
public void repaint(long tm, int x, int y, int width, int height)(Code)(Java Doc)
public void repaint(Rectangle r)(Code)(Java Doc)
public boolean requestDefaultFocus()(Code)(Java Doc)
public void requestFocus()(Code)(Java Doc)
public boolean requestFocus(boolean temporary)(Code)(Java Doc)
public boolean requestFocusInWindow()(Code)(Java Doc)
protected boolean requestFocusInWindow(boolean temporary)(Code)(Java Doc)
public void resetKeyboardActions()(Code)(Java Doc)
public void reshape(int x, int y, int w, int h)(Code)(Java Doc)
public void revalidate()(Code)(Java Doc)
public void scrollRectToVisible(Rectangle aRect)(Code)(Java Doc)
final public void setActionMap(ActionMap am)(Code)(Java Doc)
public void setAlignmentX(float alignmentX)(Code)(Java Doc)
public void setAlignmentY(float alignmentY)(Code)(Java Doc)
public void setAutoscrolls(boolean autoscrolls)(Code)(Java Doc)
public void setBackground(Color bg)(Code)(Java Doc)
public void setBorder(Border border)(Code)(Java Doc)
public void setComponentPopupMenu(JPopupMenu popup)(Code)(Java Doc)
public void setDebugGraphicsOptions(int debugOptions)(Code)(Java Doc)
public static void setDefaultLocale(Locale l)(Code)(Java Doc)
public void setDoubleBuffered(boolean aFlag)(Code)(Java Doc)
public void setEnabled(boolean enabled)(Code)(Java Doc)
public void setFocusTraversalKeys(int id, Set<? extends AWTKeyStroke> keystrokes)(Code)(Java Doc)
public void setFont(Font font)(Code)(Java Doc)
public void setForeground(Color fg)(Code)(Java Doc)
public void setInheritsPopupMenu(boolean value)(Code)(Java Doc)
final public void setInputMap(int condition, InputMap map)(Code)(Java Doc)
public void setInputVerifier(InputVerifier inputVerifier)(Code)(Java Doc)
public void setMaximumSize(Dimension maximumSize)(Code)(Java Doc)
public void setMinimumSize(Dimension minimumSize)(Code)(Java Doc)
public void setNextFocusableComponent(Component aComponent)(Code)(Java Doc)
public void setOpaque(boolean isOpaque)(Code)(Java Doc)
public void setPreferredSize(Dimension preferredSize)(Code)(Java Doc)
public void setRequestFocusEnabled(boolean requestFocusEnabled)(Code)(Java Doc)
public void setToolTipText(String text)(Code)(Java Doc)
public void setTransferHandler(TransferHandler newHandler)(Code)(Java Doc)
protected void setUI(ComponentUI newUI)(Code)(Java Doc)
public void setVerifyInputWhenFocusTarget(boolean verifyInputWhenFocusTarget)(Code)(Java Doc)
public void setVisible(boolean aFlag)(Code)(Java Doc)
public void unregisterKeyboardAction(KeyStroke aKeyStroke)(Code)(Java Doc)
public void update(Graphics g)(Code)(Java Doc)
public void updateUI()(Code)(Java Doc)
|
|
|