DefaultContourLineAttribute

Documentation of 'sgtplot.DefaultContourLineAttribute' Java class DefaultContourLineAttribute

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- sgtplot.LineAttribute
- - sgtplot.DefaultContourLineAttribute

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Attribute
```
public class DefaultContourLineAttribute
extends LineAttribute
```
Sets the default rendering style for contour line data. Color, width, and dash characteristics are DefaultContourLineAttribute properties. For individual contour lines, the characteristics can be overridden by ContourLineAttribute when used with ContourLevels.

Since:

2.0

See Also:

GridCartesianRenderer, ContourLevels, ContourLineAttribute, 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

DefaultContourLineAttribute()
Default constructor.

Constructors
Constructor and Description
`DefaultContourLineAttribute()` Default constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Object`	`copy()` Copy the `LineAttribute`.
`int`	`getCapStyle()` Get the contour line cap style.
`java.awt.Color`	`getColor()` Get the contour line color.
`ContourLineAttribute`	`getContourLineAttribute()` Get the associated `ContourLineAttribute`
`float[]`	`getDashArray()` Get dash array.
`float`	`getDashPhase()` Get the dash phase.
`java.awt.Color`	`getLabelColor()` Get the contour label color.
`java.awt.Font`	`getLabelFont()` Get the contour label font.
`java.lang.String`	`getLabelFormat()` Get the contour label format.
`double`	`getLabelHeightP()` Get the contour label height.
`java.lang.String`	`getLabelText()` Return label text from associated `ContourLineAttribute`, if none return empty string.
`float`	`getMiterLimit()` Get the contour line miter limit.
`int`	`getMiterStyle()` Get the contour line miter style.
`int`	`getSignificantDigits()` Get the number of significant digits for auto labelling.
`int`	`getStyle()` Get the contour line style.
`float`	`getWidth()` Get the contour line width.
`boolean`	`isAutoLabel()` Test if auto label is enabled.
`boolean`	`isLabelEnabled()` Test if the contour label is enabled.
`DefaultContourLineAttribute`	`setContourLineAttribute(ContourLineAttribute attr)` Set the `ContourLineAttribute` that will potentially override attributes.
`void`	`setLabelColor(java.awt.Color color)` Set the default contour label color Property Change: `labelColor`.
`void`	`setLabelEnabled(boolean sle)` Enable/disable the contour label.
`void`	`setLabelFont(java.awt.Font font)` Set the default contour label font.
`void`	`setLabelFormat(java.lang.String format)` Set the default contour label format.
`void`	`setLabelHeightP(double height)` Set the default contour label height.
`void`	`setLabelText(java.lang.String label)` Set label text for associated `ContourLineAttribute`.
`void`	`setSignificantDigits(int sig)` Set the number of significant digits for auto labelling.
`void`	`setStyle(int st)` Override the default setStyle.
`java.lang.String`	`toString()` Get a `String` representation of the `LineAttribute`.

Methods inherited from class sgtplot.LineAttribute
addPropertyChangeListener, equals, getId, getMark, getMarkHeightP, isBatch, removePropertyChangeListener, setBatch, setBatch, setCapStyle, setColor, setDashArray, setDashPhase, setId, setMark, setMarkHeightP, setMiterLimit, setMiterStyle, setWidth

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

- Constructor Detail
  - DefaultContourLineAttribute
```
public DefaultContourLineAttribute()
```
    Default constructor. Defaults are:
```
   labelColor = Color.black
 labelHeightP = 0.16
    labelFont = null
  labelFormat = ""
    sigDigits = 2
 
```
- Method Detail
  - setContourLineAttribute
```
public DefaultContourLineAttribute setContourLineAttribute(ContourLineAttribute attr)
```
    Set the ContourLineAttribute that will potentially override attributes.
  - getContourLineAttribute
```
public ContourLineAttribute getContourLineAttribute()
```
    Get the associated ContourLineAttribute
  - setLabelText
```
public void setLabelText(java.lang.String label)
```
    Set label text for associated ContourLineAttribute.
  - getLabelText
```
public java.lang.String getLabelText()
```
    Return label text from associated ContourLineAttribute, if none return empty string.
  - 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. Use associated ContourLineAttribute if it exists and has labelEnabledOverrideen set to false.
  - setLabelColor
```
public void setLabelColor(java.awt.Color color)
```
    Set the default contour label color
    Property Change: labelColor.
  - getLabelColor
```
public java.awt.Color getLabelColor()
```
    Get the contour label color. Use associated ContourLineAttribute if it exists and has labelColorOverrideen set to false.
  - setLabelHeightP
```
public void setLabelHeightP(double height)
```
    Set the default contour label height.
    Property Change: labelHeightP.
  - getLabelHeightP
```
public double getLabelHeightP()
```
    Get the contour label height. Use associated ContourLineAttribute if it exists and has labelHeightPOverrideen set to false.
  - setLabelFont
```
public void setLabelFont(java.awt.Font font)
```
    Set the default contour label font.
    Property Change: labelFont.
  - getLabelFont
```
public java.awt.Font getLabelFont()
```
    Get the contour label font. Use associated ContourLineAttribute if it exists and has labelFontOverrideen set to false.
  - setSignificantDigits
```
public void setSignificantDigits(int sig)
```
    Set the number of significant digits for auto labelling.
    Property Change: significantDigits.
  - getSignificantDigits
```
public int getSignificantDigits()
```
    Get the number of significant digits for auto labelling.
  - setLabelFormat
```
public void setLabelFormat(java.lang.String format)
```
    Set the default contour label format.
    Property Change: labelFormat.
  - getLabelFormat
```
public java.lang.String getLabelFormat()
```
    Get the contour label format. Use associated ContourLineAttribute if it exists and has labelFormatOverrideen set to false.
  - isAutoLabel
```
public boolean isAutoLabel()
```
    Test if auto label is enabled. Use associated ContourLineAttribute if it exists otherwise always returns true.
  - getDashArray
```
public float[] getDashArray()
```
    Get dash array. Use associated ContourLineAttribute if it exists and has dashArrayOverrideen set to false.
    
    Overrides:
    
    getDashArray in class LineAttribute
  - getDashPhase
```
public float getDashPhase()
```
    Get the dash phase. Use associated ContourLineAttribute if it exists and has dashPhaseOverrideen set to false.
    
    Overrides:
    
    getDashPhase in class LineAttribute
  - setStyle
```
public void setStyle(int st)
```
    Override the default setStyle. Legal styles do not include MARK or MARK_LINE.
    
    Overrides:
    
    setStyle in class LineAttribute
    
    Parameters:
    
    st - line style
  - getStyle
```
public int getStyle()
```
    Get the contour line style. Use associated ContourLineAttribute if it exists and has styleOverrideen set to false.
    
    Overrides:
    
    getStyle in class LineAttribute
    
    Returns:
    
    line style
  - getColor
```
public java.awt.Color getColor()
```
    Get the contour line color. Use associated ContourLineAttribute if it exists and has colorOverrideen set to false.
    
    Overrides:
    
    getColor in class LineAttribute
    
    Returns:
    
    line Color
  - getWidth
```
public float getWidth()
```
    Get the contour line width. Use associated ContourLineAttribute if it exists and has widthOverrideen set to false.
    
    Overrides:
    
    getWidth in class LineAttribute
    
    Returns:
    
    line width in physcial coordinates.
  - getCapStyle
```
public int getCapStyle()
```
    Get the contour line cap style. Use associated ContourLineAttribute if it exists and has capStyleOverrideen set to false.
    
    Overrides:
    
    getCapStyle in class LineAttribute
  - getMiterStyle
```
public int getMiterStyle()
```
    Get the contour line miter style. Use associated ContourLineAttribute if it exists and has miterStyleOverrideen set to false.
    
    Overrides:
    
    getMiterStyle in class LineAttribute
  - getMiterLimit
```
public float getMiterLimit()
```
    Get the contour line miter limit. Use associated ContourLineAttribute if it exists and has miterLimitOverrideen set to false.
    
    Overrides:
    
    getMiterLimit in class LineAttribute
  - 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
  - copy
```
public java.lang.Object copy()
```
    Description copied from class: LineAttribute
    
    Copy the LineAttribute.
    
    Overrides:
    
    copy in class LineAttribute
    
    Returns:
    
    new LineAttribute

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Class DefaultContourLineAttribute

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

DefaultContourLineAttribute

Method Detail

setContourLineAttribute

getContourLineAttribute

setLabelText

getLabelText

setLabelEnabled

isLabelEnabled

setLabelColor

getLabelColor

setLabelHeightP

getLabelHeightP

setLabelFont

getLabelFont

setSignificantDigits

getSignificantDigits

setLabelFormat

getLabelFormat

isAutoLabel

getDashArray

getDashPhase

setStyle

getStyle

getColor

getWidth

getCapStyle

getMiterStyle

getMiterLimit

toString

copy