JIDE 3.5.15

com.jidesoft.gauge
Class DialFrame

java.lang.Object
  extended by com.jidesoft.gauge.DialFrame

public class DialFrame
extends Object

A kind of border for a Dial, except that a frame can have a Paint as a fill and can itself be surrounded by a line border.

See Also:
Dial.setFrame(com.jidesoft.gauge.DialFrame)

Constructor Summary
DialFrame()
           
 
Method Summary
 double getArcEndAngle()
          Returns the extra angle of curvature added to the main arc making up the frame.
 Paint getFill()
          Returns the current fill used for the frame
 double getFrameWidth()
          Return the width of the frame as a proportion of the radius
 Color getInnerBorderColor()
          Returns the color of the inner border of the frame
 int getInnerBorderWidth()
          Returns the width of the inner border in pixels
 double getMidChordRadius()
          Returns the closest that the frame may pass the pivot point specified as a proportion of the dial radius
 Color getOuterBorderColor()
          Returns the Color of the outer border of the frame
 int getOuterBorderWidth()
          Returns the width of the outer border in pixels
 void setArcEndAngle(double arcEndAngle)
          The extra angle of curvature added to the main arc making up the frame.
 void setFill(Paint fill)
          Specify the fill for the frame.
 void setFrameWidth(double frameWidth)
          Specify the frame width in terms of the radius of the dial
 void setInnerBorderColor(Color innerBorderColor)
          Specify the color of the inner border of the frame
 void setInnerBorderWidth(int innerBorderWidth)
          Specify the width of the inner border in pixels
 void setMidChordRadius(double midChordRadius)
          Specify the closest that the frame may pass the pivot point specified as a proportion of the dial radius
 void setOuterBorderColor(Color outerBorderColor)
          Specify the Color of the outer border of the frame
 void setOuterBorderWidth(int outerBorderWidth)
          Specify the width of the outer border in pixels
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DialFrame

public DialFrame()
Method Detail

getFill

public Paint getFill()
Returns the current fill used for the frame

Returns:
the current fill used for the frame

setFill

public void setFill(Paint fill)
Specify the fill for the frame. You can use a solid color or a gradient paint (or even a TexturePaint...)

Parameters:
fill - the fill (paint) to use for the frame

getFrameWidth

public double getFrameWidth()
Return the width of the frame as a proportion of the radius

Returns:
the width of the frame as a proportion of the radius

setFrameWidth

public void setFrameWidth(double frameWidth)
Specify the frame width in terms of the radius of the dial

Parameters:
frameWidth - the width of the frame specified as a proportion of the radius

getInnerBorderColor

public Color getInnerBorderColor()
Returns the color of the inner border of the frame

Returns:
the color of the inner border of the frame

setInnerBorderColor

public void setInnerBorderColor(Color innerBorderColor)
Specify the color of the inner border of the frame

Parameters:
innerBorderColor - the color of the inner border of the frame

getInnerBorderWidth

public int getInnerBorderWidth()
Returns the width of the inner border in pixels

Returns:
the width of the inner border in pixels

setInnerBorderWidth

public void setInnerBorderWidth(int innerBorderWidth)
Specify the width of the inner border in pixels

Parameters:
innerBorderWidth - the width of the inner border in pixels

getOuterBorderColor

public Color getOuterBorderColor()
Returns the Color of the outer border of the frame

Returns:
the Color of the outer border of the frame

setOuterBorderColor

public void setOuterBorderColor(Color outerBorderColor)
Specify the Color of the outer border of the frame

Parameters:
outerBorderColor - the outer border Color of the frame

getOuterBorderWidth

public int getOuterBorderWidth()
Returns the width of the outer border in pixels

Returns:
the width of the outer border in pixels

setOuterBorderWidth

public void setOuterBorderWidth(int outerBorderWidth)
Specify the width of the outer border in pixels

Parameters:
outerBorderWidth - the width of the outer border in pixels

getMidChordRadius

public double getMidChordRadius()
Returns the closest that the frame may pass the pivot point specified as a proportion of the dial radius

Returns:
the closest that the frame may pass the pivot point specified as a proportion of the dial radius

setMidChordRadius

public void setMidChordRadius(double midChordRadius)
Specify the closest that the frame may pass the pivot point specified as a proportion of the dial radius

Parameters:
midChordRadius - the closes that the frame may pass to the dial pivot point

getArcEndAngle

public double getArcEndAngle()
Returns the extra angle of curvature added to the main arc making up the frame. Set this to something like 10 degrees if you don't like sharp edges.

Returns:
the extra angle of curvature added to the main arc making up the frame

setArcEndAngle

public void setArcEndAngle(double arcEndAngle)
The extra angle of curvature added to the main arc making up the frame. Set this to something like 10 degrees if you don't like sharp edges.

Parameters:
arcEndAngle - the extra angle of curvature at the end of the main frame arcs.

JIDE 3.5.15