Package com.inet.report.chart.axis
Class AbstractMarker
java.lang.Object
com.inet.report.chart.axis.AbstractMarker
- All Implemented Interfaces:
Serializable
- Direct Known Subclasses:
IntervalMarker
,LineMarker
Basic class to create markers in a chart plot.
- Since:
- 8.0
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final float
Default alpha transparency value of the marker.static final int
Default line marker color (a ABGR value representation).static final int
Default line style of the marker.static final int
Default line width of the marker.static final double
Default value. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionint
getColor()
Returns the color of the line or area of this marker.int
Returns the marker's line style.int
Returns the line width in twips.static List<FormulaField>
getMarkerReferencesIfExist
(com.inet.report.chart.axis.MarkerAxis... axis) Get all references to FormulaFields for all given Marker-Axis.protected StringBuilder
getSubProperties
(int depth) Returns the serialized properties of subclasses.void
readProperties
(Element element, Chart2 chart) Loads the XML properties of a marker.void
setColor
(int markerColor) Sets the color of the line or area of this marker.void
setLineStyle
(int lineStyle) Sets the marker's line style.void
setLineWidth
(int lineWidth) Sets the marker line width in twips.
-
Field Details
-
DEFAULT_COLOR
public static final int DEFAULT_COLORDefault line marker color (a ABGR value representation).- See Also:
-
DEFAULT_LINE_STYLE
public static final int DEFAULT_LINE_STYLEDefault line style of the marker.- See Also:
-
DEFAULT_LINE_WIDTH
public static final int DEFAULT_LINE_WIDTHDefault line width of the marker.- See Also:
-
DEFAULT_ALPHA
public static final float DEFAULT_ALPHADefault alpha transparency value of the marker.- See Also:
-
DEFAULT_VALUE
public static final double DEFAULT_VALUEDefault value. This value has a marker without initializing the value property.- See Also:
-
-
Constructor Details
-
AbstractMarker
protected AbstractMarker()Protected constructor.- Since:
- 8.0
-
-
Method Details
-
getColor
public int getColor()Returns the color of the line or area of this marker.- Returns:
- the ABGR value representing the marker color
- Since:
- 8.0
- See Also:
-
setColor(int)
ColorUtils.toJavaColor(int)
-
setColor
public void setColor(int markerColor) Sets the color of the line or area of this marker.- Parameters:
markerColor
- the ABGR value representing the marker color- Throws:
IllegalArgumentException
- if the color isRDC.COLOR_NO_COLOR
.- Since:
- 8.0
- See Also:
-
getColor()
ColorUtils.toCcColor(Color)
-
getLineStyle
public int getLineStyle()Returns the marker's line style. Has no effect by a interval marker.- Returns:
- the line style of the marker
- Since:
- 8.0
- See Also:
-
setLineStyle(int)
BorderPropertiesConstants.LINE_STYLE_DASHED
BorderPropertiesConstants.LINE_STYLE_DOTTED
BorderPropertiesConstants.LINE_STYLE_SINGLE
BorderPropertiesConstants.NO_LINE
DEFAULT_LINE_STYLE
-
setLineStyle
public void setLineStyle(int lineStyle) Sets the marker's line style. Has no effect by a interval marker.- Parameters:
lineStyle
- the line style of the marker- Throws:
IllegalArgumentException
- by unsupported line style.- Since:
- 8.0
- See Also:
-
getLineStyle()
BorderPropertiesConstants.LINE_STYLE_DASHED
BorderPropertiesConstants.LINE_STYLE_DOTTED
BorderPropertiesConstants.LINE_STYLE_SINGLE
BorderPropertiesConstants.NO_LINE
DEFAULT_LINE_STYLE
-
getLineWidth
public int getLineWidth()Returns the line width in twips.- Returns:
- the line width.
- Since:
- 8.0
- See Also:
-
setLineWidth
public void setLineWidth(int lineWidth) Sets the marker line width in twips.- Parameters:
lineWidth
- the line width- Throws:
IllegalArgumentException
- if width is less than 1.- Since:
- 8.0
- See Also:
-
getSubProperties
Returns the serialized properties of subclasses.- Parameters:
depth
- the depth of XML indent- Returns:
- the properties.
- Since:
- 8.0
-
readProperties
Loads the XML properties of a marker.- Parameters:
element
- DOM element to read marker properties fromchart
- the Chart this marker belongs to, not null- Since:
- 8.0
-
getMarkerReferencesIfExist
public static List<FormulaField> getMarkerReferencesIfExist(com.inet.report.chart.axis.MarkerAxis... axis) Get all references to FormulaFields for all given Marker-Axis.- Parameters:
axis
- all axis to get referenced FormulaFields for- Returns:
- a list with references fields, not null.
- Since:
- 11.2
-