com.klg.jclass.chart3d
Class JCContourStyle

java.lang.Object
  |
  +--com.klg.jclass.chart3d.ParentTrackChange
        |
        +--com.klg.jclass.chart3d.JCContourStyle

All Implemented Interfaces:

Serializable

public class JCContourStyle

extends ParentTrackChange

Object defining the style used to draw a contour.

See Also:

Serialized Form

Field Summary

protected com.klg.jclass.chart3d.JCFillStyle	fillStyle The fill style to be used for this contour style.
protected com.klg.jclass.chart3d.JCLineStyle	lineStyle The line style to be used for this contour style.
protected com.klg.jclass.chart3d.JCSymbolStyle	symbolStyle The symbol style to be used for this contour style.

Fields inherited from class com.klg.jclass.chart3d.ParentTrackChange

parents

Constructor Summary

JCContourStyle()
Default constructor for contour style objects.

JCContourStyle(Color fillColor)
Constructor for contour style objects.

JCContourStyle(int width, Color lineColor, int linePattern, Color fillColor, int fillPattern)
Constructor for contour style objects.

JCContourStyle(int width, Color lineColor, int linePattern, Color fillColor, int fillPattern, String shape, Color symbolColor, int symbolSize)
Constructor for contour style objects.

JCContourStyle(com.klg.jclass.chart3d.JCLineStyle lineStyle, com.klg.jclass.chart3d.JCFillStyle fillStyle, com.klg.jclass.chart3d.JCSymbolStyle symbolStyle)
Constructor for contour style objects.

Method Summary

Color	getFillBackground() Gets the value of the FillBackground property.
Color	getFillColor() Gets the value of the FillColor property.
Image	getFillImage() Gets the value of the FillImage property.
int	getFillPattern() Gets the value of the FillPattern property.
com.klg.jclass.chart3d.JCFillStyle	getFillStyle() Gets the JCFillStyle property, which controls how contour zones are filled.
int	getLineCap() Gets the value of the LineCap property.
Color	getLineColor() Gets the value of the LineColor property.
int	getLineJoin() Gets the value of the LineJoin property.
int	getLinePattern() Gets the value of the LinePattern property.
com.klg.jclass.chart3d.JCLineStyle	getLineStyle() Gets the JCLineStyle property, which controls how contour lines are drawn.
int	getLineWidth() Gets the value of the LineWidth property.
Color	getSymbolColor() Gets the value of the SymbolColor property.
String	getSymbolShape() Gets the value of the SymbolShape property.
int	getSymbolSize() Gets the value of the SymbolSize property.
com.klg.jclass.chart3d.JCSymbolStyle	getSymbolStyle() Gets the SymbolStyle property.
protected void	initialize(com.klg.jclass.chart3d.JCContour contour, int index) Initializes the contour style so that it has a lineStyle, fillStyle, and symbolStyle with valid information.
static com.klg.jclass.chart3d.JCContourStyle	makeDefault(com.klg.jclass.chart3d.JCChart3d c) Creates a default chart style.
static com.klg.jclass.chart3d.JCContourStyle	makeDefault(com.klg.jclass.chart3d.JCChart3d c, com.klg.jclass.chart3d.Changeable parent) Creates a default contour style.
void	setFillBackground(Color fillColor) Sets the value of the FillBackground property.
void	setFillColor(Color fillColor) Sets the value of the FillColor property.
void	setFillImage(Image fillImage) Sets the value of the FillImage property.
void	setFillPattern(int fillPattern) Sets the value of the FillPattern property.
void	setFillStyle(com.klg.jclass.chart3d.JCFillStyle fillStyle) Sets the JCFillStyle property, which controls how contour zones are filled.
void	setLineCap(int cap) Sets the value of the LineCap property.
void	setLineColor(Color lineColor) Sets the value of the LineColor property.
void	setLineJoin(int join) Sets the value of the LineJoin property.
void	setLinePattern(int pattern) Sets the value of the LinePattern property.
void	setLineStyle(com.klg.jclass.chart3d.JCLineStyle lineStyle) Sets the JCLineStyle property, which controls how contour lines are drawn.
void	setLineWidth(int lineWidth) Sets the value of the LineWidth property.
void	setSymbolColor(Color sc) Sets the value of the SymbolColor property.
void	setSymbolShape(String shape) Sets the value of the SymbolShape property.
void	setSymbolSize(int sz) Sets the value of the SymbolSize property.
void	setSymbolStyle(com.klg.jclass.chart3d.JCSymbolStyle symbolStyle) Sets the SymbolStyle property.

Methods inherited from class com.klg.jclass.chart3d.ParentTrackChange

addParent, clearParents, removeParent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

lineStyle

protected com.klg.jclass.chart3d.JCLineStyle lineStyle

The line style to be used for this contour style.

fillStyle

protected com.klg.jclass.chart3d.JCFillStyle fillStyle

The fill style to be used for this contour style.

symbolStyle

protected com.klg.jclass.chart3d.JCSymbolStyle symbolStyle

The symbol style to be used for this contour style.

Constructor Detail

JCContourStyle

public JCContourStyle()

Default constructor for contour style objects. Creates default line style and fill style objects.

JCContourStyle

public JCContourStyle(Color fillColor)

Constructor for contour style objects. Only the fillColor of the fillStyle is specified. All other values are at their default values.

Parameters:

fillColor - the color of the fillStyle

JCContourStyle

public JCContourStyle(int width,
                      Color lineColor,
                      int linePattern,
                      Color fillColor,
                      int fillPattern)

Constructor for contour style objects. The line width, color, and pattern are specified, as well as the fill color and pattern. The symbol style is set to the default shape and size with the specified fillColor.

Parameters:

width - the width of the line

lineColor - the color of the line

linePattern - the line pattern - see JCLineStyle for details

fillColor - the color of the fillStyle

fillPattern - the fill pattern - see JCFillStyle for details

JCContourStyle

public JCContourStyle(int width,
                      Color lineColor,
                      int linePattern,
                      Color fillColor,
                      int fillPattern,
                      String shape,
                      Color symbolColor,
                      int symbolSize)

Constructor for contour style objects. The line width, color, and pattern are specified as well as the fill color and pattern. The symbol style is set to the default shape and size with the specified symbolColor.

Parameters:

width - the width of the line

lineColor - the color of the line

linePattern - the line pattern - see JCLineStyle for details

fillColor - the color of the fillStyle.

fillPattern - the fill pattern - see JCFillStyle for details

shape - the shape of the symbolStyle - see JCSymbolStyle for details

symbolColor - the color of the symbol

symbolSize - the size of the symbol

JCContourStyle

public JCContourStyle(com.klg.jclass.chart3d.JCLineStyle lineStyle,
                      com.klg.jclass.chart3d.JCFillStyle fillStyle,
                      com.klg.jclass.chart3d.JCSymbolStyle symbolStyle)

Constructor for contour style objects.

Parameters:

lineStyle - JCLineStyle instance representing the line style for this contour style object

fillStyle - JCFillStyle instance representing the fill style for this contour style object

symbolStyle - JCSymbolStyle instance representing the symbol style for this contour style object

Method Detail

makeDefault

public static com.klg.jclass.chart3d.JCContourStyle makeDefault(com.klg.jclass.chart3d.JCChart3d c)

Creates a default chart style.

Parameters:

c - JCChart3d instance that is the parent of the created JCContourStyle object

Returns:

JCContourStyle object with default line and fill styles. The defaults are cycled, so consecutive calls will return contour styles with different fill colors.

makeDefault

public static com.klg.jclass.chart3d.JCContourStyle makeDefault(com.klg.jclass.chart3d.JCChart3d c,
                                                                com.klg.jclass.chart3d.Changeable parent)

Creates a default contour style.

Parameters:

c - JCChart3d instance that uses this JCContourStyle

parent - an instance of Changeable that will be the parent of the created JCContourStyle object

Returns:

JCContourStyle object with default line and fill styles. The defaults are cycled, so consecutive calls will return contour styles with different fill colors.

getLineStyle

public com.klg.jclass.chart3d.JCLineStyle getLineStyle()

Gets the JCLineStyle property, which controls how contour lines are drawn.

Returns:

JCLineStyle instance representing the contour line drawing style

setLineStyle

public void setLineStyle(com.klg.jclass.chart3d.JCLineStyle lineStyle)

Sets the JCLineStyle property, which controls how contour lines are drawn.

Parameters:

lineStyle - JCLineStyle instance representing the contour line drawing style

getLinePattern

public int getLinePattern()

Gets the value of the LinePattern property. The LinePattern property dictates the pattern used to draw a line. Valid values include JCLineStyle.NONE, JCLineStyle.SOLID, JCLineStyle.LONG_DASH, JCLineStyle.SHORT_DASH, JCLineStyle.LSL_DASH, and JCLineStyle.DASH_DOT.

Returns:

Line pattern enum

setLinePattern

public void setLinePattern(int pattern)

Sets the value of the LinePattern property. The LinePattern property dictates the pattern used to draw a line. Valid values include JCLineStyle.NONE, JCLineStyle.SOLID, JCLineStyle.LONG_DASH, JCLineStyle.SHORT_DASH, JCLineStyle.LSL_DASH , and JCLineStyle.DASH_DOT.

Parameters:

pattern - Line pattern enum

getLineJoin

public int getLineJoin()

Gets the value of the LineJoin property. The LineJoin property dictates the join style used to join two lines. Valid values include BasicStroke.JOIN_MITER, BasicStroke.JOIN_BEVEL, and BasicStroke.JOIN_ROUND.

Returns:

Line join enum

setLineJoin

public void setLineJoin(int join)

Sets the value of the LineJoin property. The LineJoin property dictates the join style used to join two lines. Valid values include BasicStroke.JOIN_MITER, BasicStroke.JOIN_BEVEL, and BasicStroke.JOIN_ROUND.

Parameters:

join - Line join enum

getLineCap

public int getLineCap()

Gets the value of the LineCap property. The LineCap property dictates the cap style used to end a line. Valid values include BasicStroke.CAP_BUTT, BasicStroke.CAP_ROUND, and BasicStroke.CAP_SQUARE.

Returns:

Line cap enum

setLineCap

public void setLineCap(int cap)

Sets the value of the LineCap property. The LineCap property dictates the cap style used to end a line. Valid values include BasicStroke.CAP_BUTT, BasicStroke.CAP_ROUND, and BasicStroke.CAP_SQUARE.

Parameters:

cap - Line cap enum

getLineWidth

public int getLineWidth()

Gets the value of the LineWidth property. The LineWidth property controls the line width.

Returns:

Line width

setLineWidth

public void setLineWidth(int lineWidth)

Sets the value of the LineWidth property. The LineWidth property controls the line width.

Parameters:

lineWidth - Line width

getLineColor

public Color getLineColor()

Gets the value of the LineColor property. The LineColor property determines the color used to draw a line.

Returns:

Line color

setLineColor

public void setLineColor(Color lineColor)

Sets the value of the LineColor property. The LineColor property determines the color used to draw a line.

Parameters:

lineColor - Line color

getFillStyle

public com.klg.jclass.chart3d.JCFillStyle getFillStyle()

Gets the JCFillStyle property, which controls how contour zones are filled.

Returns:

JCFillStyle instance representing the contour zone fill style

setFillStyle

public void setFillStyle(com.klg.jclass.chart3d.JCFillStyle fillStyle)

Sets the JCFillStyle property, which controls how contour zones are filled.

Parameters:

fillStyle - JCFillStyle instance representing the contour zone fill style

getFillColor

public Color getFillColor()

Gets the value of the FillColor property. The FillColor property determines the color used to fill regions in the chart.

Returns:

Fill color

setFillColor

public void setFillColor(Color fillColor)

Sets the value of the FillColor property. The FillColor property determines the color used to fill regions in the chart.

Parameters:

fillColor - Fill color

getFillBackground

public Color getFillBackground()

Gets the value of the FillBackground property. The FillBackground property determines the color used for the background when doing patterned fills in the chart.

Returns:

Fill background color

setFillBackground

public void setFillBackground(Color fillColor)

Sets the value of the FillBackground property. The FillBackground property determines the color used for the background when doing patterned fills in the chart.

Parameters:

fillColor - Fill background color

getFillPattern

public int getFillPattern()

Gets the value of the FillPattern property. The FillPattern property determines the fill pattern used to fill regions in chart.

Returns:

Fill pattern

setFillPattern

public void setFillPattern(int fillPattern)

Sets the value of the FillPattern property. The FillPattern property determines the fill pattern used to fill regions in chart.

Parameters:

fillPattern - Fill pattern

getFillImage

public Image getFillImage()

Gets the value of the FillImage property. The FillImage property is not currently used in JCChart3d.

Returns:

Fill image

setFillImage

public void setFillImage(Image fillImage)

Sets the value of the FillImage property. The FillImage property is not currently used in JCChart3d.

Parameters:

fillImage - fill image

getSymbolStyle

public com.klg.jclass.chart3d.JCSymbolStyle getSymbolStyle()

Gets the SymbolStyle property. The SymbolStyle property controls the symbol that represents an individual point.

Returns:

JCSymbolStyle instance representing the symbol drawing style

setSymbolStyle

public void setSymbolStyle(com.klg.jclass.chart3d.JCSymbolStyle symbolStyle)

Sets the SymbolStyle property. The SymbolStyle property controls the symbol that represents an individual point.

Parameters:

symbolStyle - The current symbol style object

getSymbolShape

public String getSymbolShape()

Gets the value of the SymbolShape property. The SymbolShape property determines the type of symbol that will be drawn. Valid values include JCSymbolStyle.NONE, JCSymbolStyle.DOT, JCSymbolStyle.BOX, JCSymbolStyle.TRIANGLE, JCSymbolStyle.DIAMOND, JCSymbolStyle.STAR, JCSymbolStyle.VERT_LINE, JCSymbolStyle.HORIZ_LINE, JCSymbolStyle.CROSS, JCSymbolStyle.CIRCLE, and JCSymbolStyle.SQUARE.

Returns:

Symbol shape

setSymbolShape

public void setSymbolShape(String shape)

Sets the value of the SymbolShape property. The SymbolShape property determines the type of symbol that will be drawn. Valid values include JCSymbolStyle.NONE, JCSymbolStyle.DOT, JCSymbolStyle.BOX, JCSymbolStyle.TRIANGLE, JCSymbolStyle.DIAMOND, JCSymbolStyle.STAR, JCSymbolStyle.VERT_LINE, JCSymbolStyle.HORIZ_LINE, JCSymbolStyle.CROSS, JCSymbolStyle.CIRCLE, and JCSymbolStyle.SQUARE.

Parameters:

shape - Symbol shape

getSymbolColor

public Color getSymbolColor()

Gets the value of the SymbolColor property. The SymbolColor property determines color used to paint the symbol.

Returns:

Symbol color

setSymbolColor

public void setSymbolColor(Color sc)

Sets the value of the SymbolColor property. The SymbolColor property determines color used to paint the symbol.

Parameters:

sc - Symbol color

getSymbolSize

public int getSymbolSize()

Gets the value of the SymbolSize property. The SymbolSize property determines the size of the symbols.

Returns:

Positive integer representing symbol size

setSymbolSize

public void setSymbolSize(int sz)

Sets the value of the SymbolSize property. The SymbolSize property determines the size of the symbols. When set to 0, no symbol is drawn.

Parameters:

sz - Symbol size

initialize

protected void initialize(com.klg.jclass.chart3d.JCContour contour,
                          int index)

Initializes the contour style so that it has a lineStyle, fillStyle, and symbolStyle with valid information.

Parameters:

contour - The contour object to use to get default colors

index - The index of the contour to initialize