com.sygem.swing.borders
Class FlashingBorder

java.lang.Object
  extended bycom.sygem.swing.borders.FlashingBorder
All Implemented Interfaces:
javax.swing.border.Border

public class FlashingBorder
extends java.lang.Object
implements javax.swing.border.Border

This border cycles between two borders to achieve a flashing effect.

The time between each border change can also be specified.

When each border change occurs, only the border of the component is repainted, not the whole component. This saves on processor time and guarantees each component retains its current display no matter what happens to the border.

Title: SyGem Swing Borders
Description: A set of free Borders
Copyright: Copyright (c) 2004
Company: SyGem Software

Version:
1.0b

Constructor Summary
FlashingBorder()
          Creates a FlashingBorder.
 
Method Summary
 int getAnimationDelay()
          Gets the value of the animation delay.
 javax.swing.border.Border getBorder1()
          Gets the first border used in the flashing sequence.
 javax.swing.border.Border getBorder2()
          Gets the second border used in the flashing sequence.
 java.awt.Insets getBorderInsets(java.awt.Component c)
          Returns the insets of the current border.
 boolean isBorderOpaque()
          Returns whether or not the current border is opaque.
 void paintBorder(java.awt.Component c, java.awt.Graphics g, int x, int y, int width, int height)
          Paints the border for the specified component with the specified position and size.
 void setAnimationDelay(int animationDelay)
          Sets the size of the delay between border changes.
 void setBorder1(javax.swing.border.Border border1)
          Sets the first border for the flashing sequence.
 void setBorder2(javax.swing.border.Border border2)
          Sets the second border for the flashing sequence.
 void startFlashing()
          Starts the flashing with the first border.
 void stopFlashing()
          Stops the flashing.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FlashingBorder

public FlashingBorder()
Creates a FlashingBorder. By default, the two borders in the flashing sequence are EmptyBorders.

Method Detail

getAnimationDelay

public int getAnimationDelay()
Gets the value of the animation delay.

Returns:
The animation delay

getBorder1

public javax.swing.border.Border getBorder1()
Gets the first border used in the flashing sequence.

Returns:
The first Border

getBorder2

public javax.swing.border.Border getBorder2()
Gets the second border used in the flashing sequence.

Returns:
The second Border

getBorderInsets

public java.awt.Insets getBorderInsets(java.awt.Component c)
Returns the insets of the current border.

Specified by:
getBorderInsets in interface javax.swing.border.Border
Parameters:
c - the component for which this border insets value applies
Returns:
The insets for the current border

isBorderOpaque

public boolean isBorderOpaque()
Returns whether or not the current border is opaque.

Specified by:
isBorderOpaque in interface javax.swing.border.Border
Returns:
True if the current border is opaque

paintBorder

public void paintBorder(java.awt.Component c,
                        java.awt.Graphics g,
                        int x,
                        int y,
                        int width,
                        int height)
Paints the border for the specified component with the specified position and size.

Specified by:
paintBorder in interface javax.swing.border.Border
Parameters:
c - the component for which this border is being painted
g - the paint graphics
x - the x position of the painted border
y - the y position of the painted border
width - the width of the painted border
height - the height of the painted border

setAnimationDelay

public void setAnimationDelay(int animationDelay)
Sets the size of the delay between border changes. The delay is specified in milliseconds - 1000 milliseconds = 1 second.

Parameters:
animationDelay - The number of milliseconds to wait before changing to the other border

setBorder1

public void setBorder1(javax.swing.border.Border border1)
Sets the first border for the flashing sequence.

Parameters:
border1 - The first Border to be used in the flashing sequence

setBorder2

public void setBorder2(javax.swing.border.Border border2)
Sets the second border for the flashing sequence.

Parameters:
border2 - The second Border to be used in the flashing sequence

startFlashing

public void startFlashing()
Starts the flashing with the first border.


stopFlashing

public void stopFlashing()
Stops the flashing. It can be restarted at any time using the startFlashing() method.



Copyright © 2004 SyGem Software. All Rights Reserved.