oracle.dss.gauge

Class TickMark

java.lang.Object

oracle.dss.gauge.BaseGaugeComponent

oracle.dss.gauge.TickMark

public class TickMark
extends BaseGaugeComponent

Since:

11.0

Field Summary

Fields inherited from class oracle.dss.gauge.BaseGaugeComponent

m_commonGauge, m_compType

Constructor Summary

Constructors

Constructor and Description
TickMark(CommonGauge gauge)

Method Summary

Methods

Modifier and Type	Method and Description
int	getContent() Gets the tick content specification for all gauges in this gauge set.
java.awt.Color	getMajorTickColor() Retrieves the color of the major tick marks.
int	getMajorTickCount() Gets the MajorTick count for all gauges in this gauge set.
double	getMajorTickStep() Gets the MajorTick count for all gauges in this gauge set.
java.awt.Color	getMinorTickColor() Retrieves the color of the minor tick marks.
int	getMinorTickCount() Gets the minor tick count for all gauges in this gauge set.
double	getMinorTickStep() Gets the minor tick step for all gauges in this gauge set.
void	setContent(int content) Sets the tick content specification for all gauges in this gauge set.
void	setMajorTickColor(java.awt.Color color) Specifies the color of the major tick marks.
void	setMajorTickCount(int tickCount) Sets the MajorTick count for all gauges in this gauge set.
void	setMajorTickStep(double tickStep) Sets the MajorTick step for all gauges in this gauge set.
void	setMinorTickColor(java.awt.Color color) Specifies the color of the minor tick marks.
void	setMinorTickCount(int tickCount) Sets the minor tick count for all gauges in this gauge set.
void	setMinorTickStep(double tickStep) Sets the minor tick step for all gauges in this gauge set.

Methods inherited from class oracle.dss.gauge.BaseGaugeComponent

getComponentName, getComponentType, selectObject

Methods inherited from class java.lang.Object

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

Constructor Detail

TickMark

public TickMark(CommonGauge gauge)

Method Detail

getContent

public int getContent()

Gets the tick content specification for all gauges in this gauge set. Returned value represents 0 or more values added together to specify which tick marks should appear in a gauge.

Returns:

Integer representing 0 or more tick types to display; valid values include those constants in GaugeConstants beginning with TICK_.

setContent

public void setContent(int content)

Sets the tick content specification for all gauges in this gauge set. Returned value represents 0 or more values added together to specify which tick types should appear in a gauge.

Parameters:

content - Integer representing 0 or more tick types to display; valid values include those constants in GaugeConstants beginning with TICK_.

getMajorTickCount

public int getMajorTickCount()

Gets the MajorTick count for all gauges in this gauge set. When the count is < 0 the increments are calculated automatically based on the gauge width.

Returns:

Integer representing MajorTick count.

setMajorTickCount

public void setMajorTickCount(int tickCount)

Sets the MajorTick count for all gauges in this gauge set. When the specified count is < 0 the increments are calculated automatically based on the gauge width.

Parameters:

tickCount - Integer representing MajorTick count.

getMajorTickColor

public java.awt.Color getMajorTickColor()

Retrieves the color of the major tick marks.

Returns:

The color of the major tick marks.

setMajorTickColor

public void setMajorTickColor(java.awt.Color color)

Specifies the color of the major tick marks.

Parameters:

color - The color of the major tick marks.

getMinorTickCount

public int getMinorTickCount()

Gets the minor tick count for all gauges in this gauge set. The minor tick count specifies the number of minor ticks between the major ticks.
Minor tick marks are only drawn if tick mark content includes TC_INCREMENTS.
Minor tick marks are not drawn between threshold (TC_THRESHOLD) ticks.

Returns:

Integer representing minor tick count.

setMinorTickCount

public void setMinorTickCount(int tickCount)

Sets the minor tick count for all gauges in this gauge set. The minor tick count specifies the number of minor ticks between the major ticks.
Minor tick marks are only drawn if tick mark content includes TC_INCREMENTS.
Minor tick marks are not drawn between threshold (TC_THRESHOLD) ticks.

Parameters:

tickCount - Integer representing minor tick count.

getMinorTickColor

public java.awt.Color getMinorTickColor()

Retrieves the color of the minor tick marks.

Returns:

The color of the minor tick marks.

setMinorTickColor

public void setMinorTickColor(java.awt.Color color)

Specifies the color of the minor tick marks.

Parameters:

color - The color of the minor tick marks.

getMinorTickStep

public double getMinorTickStep()

Gets the minor tick step for all gauges in this gauge set. The minor tick step specifies the increment of minor ticks between the major ticks.
Minor tick marks are only drawn if tick mark content includes TC_INCREMENTS.
Minor tick marks are not drawn between threshold (TC_THRESHOLD) ticks.
Note: The number of minor ticks is limited to 500 in a gauge

Returns:

Integer representing minor tick count.

setMinorTickStep

public void setMinorTickStep(double tickStep)

Sets the minor tick step for all gauges in this gauge set. The minor tick step specifies the increment of minor ticks between the major ticks.
Minor tick marks are only drawn if tick mark content includes TC_INCREMENTS.
Minor tick marks are not drawn between threshold (TC_THRESHOLD) ticks.
Note: The number of minor ticks is limited to 500 in a gauge

Parameters:

tickStep - representing minor tick count.

getMajorTickStep

public double getMajorTickStep()

Gets the MajorTick count for all gauges in this gauge set.
Note: The number of major ticks is limited to 100 in a gauge

Returns:

representing MajorTick step.

setMajorTickStep

public void setMajorTickStep(double tickStep)

Sets the MajorTick step for all gauges in this gauge set.
Note: The number of major ticks is limited to 100 in a gauge

Parameters:

tickStep - representing MajorTick step.