ContourLineAttribute

Documentation of 'sgtplot.ContourLineAttribute' Java class ContourLineAttribute

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- sgtplot.LineAttribute
- - sgtplot.ContourLineAttribute

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Attribute
```
public class ContourLineAttribute
extends LineAttribute
```
Sets the rendering style for a contour line. Color, width, and dash characteristics are ContourLineAttribute properties.

Since:

2.0

See Also:

LineCartesianRenderer, ContourLevels, Serialized Form

Field Summary
- Fields inherited from class sgtplot.LineAttribute
  CAP_BUTT, CAP_ROUND, CAP_SQUARE, DASHED, HEAVY, HIGHLIGHT, JOIN_BEVEL, JOIN_MITER, JOIN_ROUND, MARK, MARK_LINE, SOLID, STROKE

Constructor Summary

Constructors
Constructor and Description
`ContourLineAttribute()` Default constructor.
`ContourLineAttribute(int style)` Constructor using default Color.
`ContourLineAttribute(int style, java.awt.Color color)` `ContourLineAttribute` constructor.
`ContourLineAttribute(int style, int mark, java.awt.Color color)` `ContourLineAttribute` constructor for plot marks.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Object`	`copy()` Copy the `ContourLineAttribute`.
`java.awt.Color`	`getLabelColor()` Get the color of the contour label
`java.awt.Font`	`getLabelFont()` Get the contour label font
`java.lang.String`	`getLabelFormat()` Get the contour label format
`double`	`getLabelHeightP()` Get the label height in physical units
`java.lang.String`	`getLabelText()` Get the label text.
`boolean`	`isAutoLabel()` Is auto labelling on?
`boolean`	`isCapStyleOverridden()` Test if cap style is overridden by `DefaultContourLineAttribute`.
`boolean`	`isColorOverridden()` Test if color is overridden by `DefaultContourLineAttribute`.
`boolean`	`isDashArrayOverridden()` Test if dashArray is overridden by `DefaultContourLineAttribute`.
`boolean`	`isDashPhaseOverridden()` Test if dashPhase is overridden by `DefaultContourLineAttribute`.
`boolean`	`isLabelColorOverridden()` Test if labelColor is overridden by `DefaultContourLineAttribute`.
`boolean`	`isLabelEnabled()` Test if the contour label is enabled.
`boolean`	`isLabelEnabledOverridden()` Test if labelEnabled is overridden by `DefaultContourLineAttribute`.
`boolean`	`isLabelFontOverridden()` Test if labelFont is overridden by `DefaultContourLineAttribute`.
`boolean`	`isLabelFormatOverridden()` Test if labelFormat is overridden by `DefaultContourLineAttribute`.
`boolean`	`isLabelHeightPOverridden()` Test if labelHeightP is overridden by `DefaultContourLineAttribute`.
`boolean`	`isMiterLimitOverridden()` Test if miter limit is overridden by `DefaultContourLineAttribute`.
`boolean`	`isMiterStyleOverridden()` Test if miter style is overridden by `DefaultContourLineAttribute`.
`boolean`	`isStyleOverridden()` Test if style is overridden by `DefaultContourLineAttribute`.
`boolean`	`isWidthOverridden()` Test if width is overridden by `DefaultContourLineAttribute`.
`void`	`setAutoLabel(boolean auto)` Create contour label from value and format.
`void`	`setCapStyle(int style)` Set the current line cap style.
`void`	`setCapStyleOverridden(boolean override)` Enable/disable having `DefaultContourLineAttribute` override `ContourLineAttribute` behavior of cap style.
`void`	`setColor(java.awt.Color c)` Set the line `Color`.
`void`	`setColorOverridden(boolean override)` Enable/disable having `DefaultContourLineAttribute` override `ContourLineAttribute` behavior of color.
`void`	`setDashArray(float[] dashes)` Set the dash characteristics.
`void`	`setDashArrayOverridden(boolean override)` Enable/disable having `DefaultContourLineAttribute` override `ContourLineAttribute` behavior of dashArray.
`void`	`setDashPhase(float phase)` Set line dash phase.
`void`	`setDashPhaseOverridden(boolean override)` Enable/disable having `DefaultContourLineAttribute` override `ContourLineAttribute` behavior of dashPhase.
`void`	`setLabelColor(java.awt.Color color)` Change the color of the contour label Property Change: `labelColor`.
`void`	`setLabelColorOverridden(boolean override)` Enable/disable having `DefaultContourLineAttribute` override `ContourLineAttribute` behavior of labelColor.
`void`	`setLabelEnabled(boolean sle)` Enable/disable the contour label.
`void`	`setLabelEnabledOverridden(boolean override)` Enable/disable having `DefaultContourLineAttribute` override `ContourLineAttribute` behavior of labelEnabled.
`void`	`setLabelFont(java.awt.Font font)` Set the contour label font.
`void`	`setLabelFontOverridden(boolean override)` Enable/disable having `DefaultContourLineAttribute` override `ContourLineAttribute` behavior of labelFont.
`void`	`setLabelFormat(java.lang.String format)` Set the format for the contour label.
`void`	`setLabelFormatOverridden(boolean override)` Enable/disable having `DefaultContourLineAttribute` override `ContourLineAttribute` behavior of labelFormat.
`void`	`setLabelHeightP(double height)` Set the label height in physical units Property Change: `labelHeightP`.
`void`	`setLabelHeightPOverridden(boolean override)` Enable/disable having `DefaultContourLineAttribute` override `ContourLineAttribute` behavior of labelHeightP.
`void`	`setLabelText(java.lang.String label)` Set the text to be used for labelling the contour line.
`void`	`setMiterLimit(float t)` Set the miter limit.
`void`	`setMiterLimitOverridden(boolean override)` Enable/disable having `DefaultContourLineAttribute` override `ContourLineAttribute` behavior of miter limit.
`void`	`setMiterStyle(int style)` Set the current miter style.
`void`	`setMiterStyleOverridden(boolean override)` Enable/disable having `DefaultContourLineAttribute` override `ContourLineAttribute` behavior of miter style.
`void`	`setStyle(int st)` Set the line style.
`void`	`setStyleOverridden(boolean override)` Enable/disable having `DefaultContourLineAttribute` override `ContourLineAttribute` behavior of style.
`void`	`setWidth(float t)` Set the line width in physical units.
`void`	`setWidthOverridden(boolean override)` Enable/disable having `DefaultContourLineAttribute` override `ContourLineAttribute` behavior of width.
`java.lang.String`	`toString()` Get a `String` representation of the `LineAttribute`.

Methods inherited from class sgtplot.LineAttribute
addPropertyChangeListener, equals, getCapStyle, getColor, getDashArray, getDashPhase, getId, getMark, getMarkHeightP, getMiterLimit, getMiterStyle, getStyle, getWidth, isBatch, removePropertyChangeListener, setBatch, setBatch, setId, setMark, setMarkHeightP

Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ContourLineAttribute
```
public ContourLineAttribute()
```
    Default constructor.
  - ContourLineAttribute
```
public ContourLineAttribute(int style)
```
    Constructor using default Color. Default are:
```
   labelColor = Color.black
 labelHeightP = 0.16
    labelFont = null
  labelFormat = ""
 
```
  - ContourLineAttribute
```
public ContourLineAttribute(int style,
                            java.awt.Color color)
```
    ContourLineAttribute constructor.
    
    Parameters:
    
    style - line style
    
    color - line Color
    
    See Also:
    
    Color
  - ContourLineAttribute
```
public ContourLineAttribute(int style,
                            int mark,
                            java.awt.Color color)
```
    ContourLineAttribute constructor for plot marks.
    
    Parameters:
    
    style - line sytle
    
    mark - plot mark
    
    color - line Color
- Method Detail
  - copy
```
public java.lang.Object copy()
```
    Copy the ContourLineAttribute.
    
    Overrides:
    
    copy in class LineAttribute
    
    Returns:
    
    new ContourLineAttribute
  - setLabelText
```
public void setLabelText(java.lang.String label)
```
    Set the text to be used for labelling the contour line.
    Property Change: labelText.
  - getLabelText
```
public java.lang.String getLabelText()
```
    Get the label text.
  - setLabelEnabled
```
public void setLabelEnabled(boolean sle)
```
    Enable/disable the contour label.
    Property Change: labelEnabled.
  - isLabelEnabled
```
public boolean isLabelEnabled()
```
    Test if the contour label is enabled.
  - setLabelColor
```
public void setLabelColor(java.awt.Color color)
```
    Change the color of the contour label
    Property Change: labelColor.
  - getLabelColor
```
public java.awt.Color getLabelColor()
```
    Get the color of the contour label
  - setLabelHeightP
```
public void setLabelHeightP(double height)
```
    Set the label height in physical units
    Property Change: labelHeightP.
  - getLabelHeightP
```
public double getLabelHeightP()
```
    Get the label height in physical units
  - setLabelFont
```
public void setLabelFont(java.awt.Font font)
```
    Set the contour label font.
    Property Change: labelFont.
  - getLabelFont
```
public java.awt.Font getLabelFont()
```
    Get the contour label font
  - setLabelFormat
```
public void setLabelFormat(java.lang.String format)
```
    Set the format for the contour label. The format is used with Format.
    Property Change: labelFormat.
    
    See Also:
    
    Format
  - getLabelFormat
```
public java.lang.String getLabelFormat()
```
    Get the contour label format
  - setAutoLabel
```
public void setAutoLabel(boolean auto)
```
    Create contour label from value and format.
    Property Change: autoLabel.
  - isAutoLabel
```
public boolean isAutoLabel()
```
    Is auto labelling on?
  - isLabelEnabledOverridden
```
public boolean isLabelEnabledOverridden()
```
    Test if labelEnabled is overridden by DefaultContourLineAttribute.
  - setLabelEnabledOverridden
```
public void setLabelEnabledOverridden(boolean override)
```
    Enable/disable having DefaultContourLineAttribute override ContourLineAttribute behavior of labelEnabled.
    Property Change: labelEnabledOverridden.
    
    See Also:
    
    DefaultContourLineAttribute
  - isLabelColorOverridden
```
public boolean isLabelColorOverridden()
```
    Test if labelColor is overridden by DefaultContourLineAttribute.
  - setLabelColorOverridden
```
public void setLabelColorOverridden(boolean override)
```
    Enable/disable having DefaultContourLineAttribute override ContourLineAttribute behavior of labelColor.
    Property Change: labelColorOverridden.
    
    See Also:
    
    DefaultContourLineAttribute
  - isLabelHeightPOverridden
```
public boolean isLabelHeightPOverridden()
```
    Test if labelHeightP is overridden by DefaultContourLineAttribute.
  - setLabelHeightPOverridden
```
public void setLabelHeightPOverridden(boolean override)
```
    Enable/disable having DefaultContourLineAttribute override ContourLineAttribute behavior of labelHeightP.
    Property Change: labelHeightPOverridden.
    
    See Also:
    
    DefaultContourLineAttribute
  - isLabelFontOverridden
```
public boolean isLabelFontOverridden()
```
    Test if labelFont is overridden by DefaultContourLineAttribute.
  - setLabelFontOverridden
```
public void setLabelFontOverridden(boolean override)
```
    Enable/disable having DefaultContourLineAttribute override ContourLineAttribute behavior of labelFont.
    Property Change: labelFontOverridden.
    
    See Also:
    
    DefaultContourLineAttribute
  - isLabelFormatOverridden
```
public boolean isLabelFormatOverridden()
```
    Test if labelFormat is overridden by DefaultContourLineAttribute.
  - setLabelFormatOverridden
```
public void setLabelFormatOverridden(boolean override)
```
    Enable/disable having DefaultContourLineAttribute override ContourLineAttribute behavior of labelFormat.
    Property Change: labelFormatOverridden.
    
    See Also:
    
    DefaultContourLineAttribute
  - setDashArray
```
public void setDashArray(float[] dashes)
```
    Description copied from class: LineAttribute
    
    Set the dash characteristics. Lengths are in physical units.
    Property Change: dashArray.
    
    Overrides:
    
    setDashArray in class LineAttribute
  - isDashArrayOverridden
```
public boolean isDashArrayOverridden()
```
    Test if dashArray is overridden by DefaultContourLineAttribute.
  - setDashArrayOverridden
```
public void setDashArrayOverridden(boolean override)
```
    Enable/disable having DefaultContourLineAttribute override ContourLineAttribute behavior of dashArray.
    Property Change: dashArrayOverridden.
    
    See Also:
    
    DefaultContourLineAttribute
  - setDashPhase
```
public void setDashPhase(float phase)
```
    Description copied from class: LineAttribute
    
    Set line dash phase.
    Property Change: dashPhase.
    
    Overrides:
    
    setDashPhase in class LineAttribute
  - isDashPhaseOverridden
```
public boolean isDashPhaseOverridden()
```
    Test if dashPhase is overridden by DefaultContourLineAttribute.
  - setDashPhaseOverridden
```
public void setDashPhaseOverridden(boolean override)
```
    Enable/disable having DefaultContourLineAttribute override ContourLineAttribute behavior of dashPhase.
    Property Change: dashPhaseOverridden.
    
    See Also:
    
    DefaultContourLineAttribute
  - setStyle
```
public void setStyle(int st)
```
    Description copied from class: LineAttribute
    
    Set the line style.
    Property Change: style.
    
    Overrides:
    
    setStyle in class LineAttribute
    
    Parameters:
    
    st - line style
  - isStyleOverridden
```
public boolean isStyleOverridden()
```
    Test if style is overridden by DefaultContourLineAttribute.
  - setStyleOverridden
```
public void setStyleOverridden(boolean override)
```
    Enable/disable having DefaultContourLineAttribute override ContourLineAttribute behavior of style.
    Property Change: styleOverridden.
    
    See Also:
    
    DefaultContourLineAttribute
  - setColor
```
public void setColor(java.awt.Color c)
```
    Description copied from class: LineAttribute
    
    Set the line Color.
    Property Change: color.
    
    Overrides:
    
    setColor in class LineAttribute
    
    Parameters:
    
    c - line Color
  - isColorOverridden
```
public boolean isColorOverridden()
```
    Test if color is overridden by DefaultContourLineAttribute.
  - setColorOverridden
```
public void setColorOverridden(boolean override)
```
    Enable/disable having DefaultContourLineAttribute override ContourLineAttribute behavior of color.
    Property Change: colorOverridden.
    
    See Also:
    
    DefaultContourLineAttribute
  - setWidth
```
public void setWidth(float t)
```
    Description copied from class: LineAttribute
    
    Set the line width in physical units.
    Property Change: width.
    
    Overrides:
    
    setWidth in class LineAttribute
    
    Parameters:
    
    t - line width
  - isWidthOverridden
```
public boolean isWidthOverridden()
```
    Test if width is overridden by DefaultContourLineAttribute.
  - setWidthOverridden
```
public void setWidthOverridden(boolean override)
```
    Enable/disable having DefaultContourLineAttribute override ContourLineAttribute behavior of width.
    Property Change: widthOverridden.
    
    See Also:
    
    DefaultContourLineAttribute
  - setCapStyle
```
public void setCapStyle(int style)
```
    Description copied from class: LineAttribute
    
    Set the current line cap style. Cap styles include CAP_BUTT, CAP_ROUND, and CAP_SQUARE.
    Property Change: capStyle.
    
    Overrides:
    
    setCapStyle in class LineAttribute
  - isCapStyleOverridden
```
public boolean isCapStyleOverridden()
```
    Test if cap style is overridden by DefaultContourLineAttribute.
  - setCapStyleOverridden
```
public void setCapStyleOverridden(boolean override)
```
    Enable/disable having DefaultContourLineAttribute override ContourLineAttribute behavior of cap style.
    Property Change: capStyleOverridden.
    
    See Also:
    
    DefaultContourLineAttribute
  - setMiterStyle
```
public void setMiterStyle(int style)
```
    Description copied from class: LineAttribute
    
    Set the current miter style. Styles include JOIN_MITER, JOIN_ROUND, and JOIN_BEVEL.
    Property Change: miterStyle.
    
    Overrides:
    
    setMiterStyle in class LineAttribute
  - isMiterStyleOverridden
```
public boolean isMiterStyleOverridden()
```
    Test if miter style is overridden by DefaultContourLineAttribute.
  - setMiterStyleOverridden
```
public void setMiterStyleOverridden(boolean override)
```
    Enable/disable having DefaultContourLineAttribute override ContourLineAttribute behavior of miter style.
    Property Change: miterStyleOverridden.
    
    See Also:
    
    DefaultContourLineAttribute
  - setMiterLimit
```
public void setMiterLimit(float t)
```
    Description copied from class: LineAttribute
    
    Set the miter limit.
    Property Change: miterLimit.
    
    Overrides:
    
    setMiterLimit in class LineAttribute
  - isMiterLimitOverridden
```
public boolean isMiterLimitOverridden()
```
    Test if miter limit is overridden by DefaultContourLineAttribute.
  - setMiterLimitOverridden
```
public void setMiterLimitOverridden(boolean override)
```
    Enable/disable having DefaultContourLineAttribute override ContourLineAttribute behavior of miter limit.
    Property Change: miterLimitOverridden.
    
    See Also:
    
    DefaultContourLineAttribute
  - toString
```
public java.lang.String toString()
```
    Description copied from class: LineAttribute
    
    Get a String representation of the LineAttribute.
    
    Specified by:
    
    toString in interface Attribute
    
    Overrides:
    
    toString in class LineAttribute
    
    Returns:
    
    String representation

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Class ContourLineAttribute

Field Summary

Fields inherited from class sgtplot.LineAttribute

Constructor Summary

Method Summary

Methods inherited from class sgtplot.LineAttribute

Methods inherited from class java.lang.Object

Constructor Detail

ContourLineAttribute

ContourLineAttribute

ContourLineAttribute

ContourLineAttribute

Method Detail

copy

setLabelText

getLabelText

setLabelEnabled

isLabelEnabled

setLabelColor

getLabelColor

setLabelHeightP

getLabelHeightP

setLabelFont

getLabelFont

setLabelFormat

getLabelFormat

setAutoLabel

isAutoLabel

isLabelEnabledOverridden

setLabelEnabledOverridden

isLabelColorOverridden

setLabelColorOverridden

isLabelHeightPOverridden

setLabelHeightPOverridden

isLabelFontOverridden

setLabelFontOverridden

isLabelFormatOverridden

setLabelFormatOverridden

setDashArray

isDashArrayOverridden

setDashArrayOverridden

setDashPhase

isDashPhaseOverridden

setDashPhaseOverridden

setStyle

isStyleOverridden

setStyleOverridden

setColor

isColorOverridden

setColorOverridden

setWidth

isWidthOverridden

setWidthOverridden

setCapStyle

isCapStyleOverridden

setCapStyleOverridden

setMiterStyle

isMiterStyleOverridden

setMiterStyleOverridden

setMiterLimit

isMiterLimitOverridden

setMiterLimitOverridden

toString