au.edu.jcu.hermes.ui.swing.core.plaf
Class EtchedPositionalBorder

java.lang.Object
  extended by javax.swing.border.AbstractBorder
      extended by au.edu.jcu.hermes.ui.swing.core.plaf.EtchedPositionalBorder
All Implemented Interfaces:
java.io.Serializable, javax.swing.border.Border

public class EtchedPositionalBorder
extends javax.swing.border.AbstractBorder

See Also:
Serialized Form

Nested Class Summary
static class EtchedPositionalBorder.Position
           
 
Field Summary
protected  int etchType
           
protected  java.awt.Color highlight
           
static int LOWERED
          Lowered etched type.
static int RAISED
          Raised etched type.
protected  java.awt.Color shadow
           
 
Constructor Summary
EtchedPositionalBorder()
          Creates a lowered etched border whose colors will be derived from the background color of the component passed into the paintBorder method.
EtchedPositionalBorder(java.awt.Color highlight, java.awt.Color shadow, EtchedPositionalBorder.Position position)
          Creates a lowered etched border with the specified highlight and shadow colors.
EtchedPositionalBorder(int etchType, java.awt.Color highlight, java.awt.Color shadow, EtchedPositionalBorder.Position position)
          Creates an etched border with the specified etch-type, highlight and shadow colors.
EtchedPositionalBorder(int etchType, EtchedPositionalBorder.Position position)
          Creates an etched border with the specified etch-type whose colors will be derived from the background color of the component passed into the paintBorder method.
 
Method Summary
 java.awt.Insets getBorderInsets(java.awt.Component c)
          Returns the insets of the border.
 java.awt.Insets getBorderInsets(java.awt.Component c, java.awt.Insets insets)
          Reinitialize the insets parameter with this Border's current Insets.
 int getEtchType()
          Returns which etch-type is set on the etched border.
 java.awt.Color getHighlightColor()
          Returns the highlight color of the etched border.
 java.awt.Color getHighlightColor(java.awt.Component c)
          Returns the highlight color of the etched border when rendered on the specified component.
 java.awt.Color getShadowColor()
          Returns the shadow color of the etched border.
 java.awt.Color getShadowColor(java.awt.Component c)
          Returns the shadow color of the etched border when rendered on the specified component.
 boolean isBorderOpaque()
          Returns whether or not the 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.
 
Methods inherited from class javax.swing.border.AbstractBorder
getInteriorRectangle, getInteriorRectangle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

RAISED

public static final int RAISED
Raised etched type.

See Also:
Constant Field Values

LOWERED

public static final int LOWERED
Lowered etched type.

See Also:
Constant Field Values

etchType

protected int etchType

highlight

protected java.awt.Color highlight

shadow

protected java.awt.Color shadow
Constructor Detail

EtchedPositionalBorder

public EtchedPositionalBorder()
Creates a lowered etched border whose colors will be derived from the background color of the component passed into the paintBorder method.


EtchedPositionalBorder

public EtchedPositionalBorder(int etchType,
                              EtchedPositionalBorder.Position position)
Creates an etched border with the specified etch-type whose colors will be derived from the background color of the component passed into the paintBorder method.

Parameters:
etchType - the type of etch to be drawn by the border

EtchedPositionalBorder

public EtchedPositionalBorder(java.awt.Color highlight,
                              java.awt.Color shadow,
                              EtchedPositionalBorder.Position position)
Creates a lowered etched border with the specified highlight and shadow colors.

Parameters:
highlight - the color to use for the etched highlight
shadow - the color to use for the etched shadow

EtchedPositionalBorder

public EtchedPositionalBorder(int etchType,
                              java.awt.Color highlight,
                              java.awt.Color shadow,
                              EtchedPositionalBorder.Position position)
Creates an etched border with the specified etch-type, highlight and shadow colors.

Parameters:
etchType - the type of etch to be drawn by the border
highlight - the color to use for the etched highlight
shadow - the color to use for the etched shadow
Method Detail

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
Overrides:
paintBorder in class javax.swing.border.AbstractBorder
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

getBorderInsets

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

Specified by:
getBorderInsets in interface javax.swing.border.Border
Overrides:
getBorderInsets in class javax.swing.border.AbstractBorder
Parameters:
c - the component for which this border insets value applies

getBorderInsets

public java.awt.Insets getBorderInsets(java.awt.Component c,
                                       java.awt.Insets insets)
Reinitialize the insets parameter with this Border's current Insets.

Overrides:
getBorderInsets in class javax.swing.border.AbstractBorder
Parameters:
c - the component for which this border insets value applies
insets - the object to be reinitialized

isBorderOpaque

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

Specified by:
isBorderOpaque in interface javax.swing.border.Border
Overrides:
isBorderOpaque in class javax.swing.border.AbstractBorder

getEtchType

public int getEtchType()
Returns which etch-type is set on the etched border.


getHighlightColor

public java.awt.Color getHighlightColor(java.awt.Component c)
Returns the highlight color of the etched border when rendered on the specified component. If no highlight color was specified at instantiation, the highlight color is derived from the specified component's background color.

Parameters:
c - the component for which the highlight may be derived

getHighlightColor

public java.awt.Color getHighlightColor()
Returns the highlight color of the etched border. Will return null if no highlight color was specified at instantiation.


getShadowColor

public java.awt.Color getShadowColor(java.awt.Component c)
Returns the shadow color of the etched border when rendered on the specified component. If no shadow color was specified at instantiation, the shadow color is derived from the specified component's background color.

Parameters:
c - the component for which the shadow may be derived

getShadowColor

public java.awt.Color getShadowColor()
Returns the shadow color of the etched border. Will return null if no shadow color was specified at instantiation.