Class FillMode
- java.lang.Object
-
- uk.ac.starlink.ttools.plot2.layer.FillMode
-
@Equality public class FillMode extends java.lang.Object
Describes how a region above the axis is represented visually. It can be represented by a line, a filled region, or both. Both parts may be drawn with variable transparency.- Since:
- 27 Mar 2015
- Author:
- Mark Taylor
-
-
Constructor Summary
Constructors Constructor Description FillMode(java.lang.String name, double lineAlpha, double fillAlpha, java.lang.String description)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description javax.swing.Icon
createIcon(int[] data, java.awt.Color color, java.awt.Stroke stroke, int pad)
Returns an icon representing this fill mode.boolean
equals(java.lang.Object o)
java.lang.String
getDescription()
Returns a short description for this mode.float
getFillAlpha()
Returns the alpha value for filling the area.float
getLineAlpha()
Returns the alpha value for drawing a line.java.lang.String
getName()
Returns the name for this mode.boolean
hasFill()
Indicates whether the area is filled.int
hashCode()
boolean
hasLine()
Indicates whether a line is drawn.boolean
isOpaque()
Indicates whether this mode represents opaque drawing.java.lang.String
toString()
-
-
-
Constructor Detail
-
FillMode
public FillMode(java.lang.String name, double lineAlpha, double fillAlpha, java.lang.String description)
Constructor.- Parameters:
name
- mode namelineAlpha
- alpha for line drawing (zero means no line)fillAlpha
- alpha for area filling (zero means no fill)description
- plain text description
-
-
Method Detail
-
getName
public java.lang.String getName()
Returns the name for this mode.- Returns:
- name
-
getDescription
public java.lang.String getDescription()
Returns a short description for this mode.- Returns:
- plain text description
-
getLineAlpha
public float getLineAlpha()
Returns the alpha value for drawing a line.- Returns:
- line alpha in range 0..1, zero for no line
-
getFillAlpha
public float getFillAlpha()
Returns the alpha value for filling the area.- Returns:
- fill alpha in range 0..1, zero for no fill
-
hasLine
public boolean hasLine()
Indicates whether a line is drawn.- Returns:
- lineAlpha>0
-
hasFill
public boolean hasFill()
Indicates whether the area is filled.- Returns:
- fillAlpha>0
-
isOpaque
public boolean isOpaque()
Indicates whether this mode represents opaque drawing.- Returns:
- true only if no transparency is applied
-
createIcon
public javax.swing.Icon createIcon(int[] data, java.awt.Color color, java.awt.Stroke stroke, int pad)
Returns an icon representing this fill mode.- Parameters:
data
- Y data values as integer pixel levels above 0color
- base colourstroke
- line strokepad
- number of pixels on all sides to pad- Returns:
- icon
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equals
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-