oracle.dss.gauge
Class TickLabel

java.lang.Object
  oracle.dss.gauge.BaseGaugeComponent
      oracle.dss.gauge.BaseText
          oracle.dss.gauge.TickLabel

All Implemented Interfaces:

FontAttribute

public class TickLabel
extends BaseText

Since:

4.0

Field Summary

static java.lang.String	name
protected static java.lang.String	tc_increments
protected static java.lang.String	tc_metric
protected static java.lang.String	tc_minmax
protected static java.lang.String	tc_none
protected static java.lang.String	tc_threshold
protected static java.lang.String	tlp_exterior
protected static java.lang.String	tlp_interior

Fields inherited from class oracle.dss.gauge.BaseText

m_defaultFont, m_defaultFontColor, m_fontColorKey, m_fontKey, m_isGaugeSetComponent

Fields inherited from class oracle.dss.gauge.BaseGaugeComponent

m_commonGauge, m_compType

Constructor Summary

TickLabel(CommonGauge gauge)

Method Summary

static int	convertTickContentToInt(java.lang.String string)
static int	convertTickLabelPositionToInt(java.lang.String string)
int	getContent() Gets the tick label content specification for all gauges in this gauge set.
int	getNumberType() Gets the type of number displayed in axis labels of gauge set.
int	getPosition() Gets the tick label position for all gauges in this gauge set.
ViewFormat	getViewFormat() Retrieves a ViewFormat object for tick labels.
void	setContent(int content) Sets the tick label content specification for all gauges in this gauge set.
void	setNumberType(int type) Sets the type of number to be displayed in axis labels of gauge set.
void	setPosition(int position) Sets the tick label position for all gauges in this gauge set.
void	setViewFormat(ViewFormat viewFormat) Specifies a ViewFormat object for tick labels.

Methods inherited from class oracle.dss.gauge.BaseText

getFont, getFontColor, setFont, setFontColor

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

Field Detail

name

public static final java.lang.String name

See Also:

Constant Field Values

tc_none

protected static final java.lang.String tc_none

See Also:

Constant Field Values

For internal use only. Application developers should not use this

tc_minmax

protected static final java.lang.String tc_minmax

See Also:

Constant Field Values

For internal use only. Application developers should not use this

tc_increments

protected static final java.lang.String tc_increments

See Also:

Constant Field Values

For internal use only. Application developers should not use this

tc_threshold

protected static final java.lang.String tc_threshold

See Also:

Constant Field Values

For internal use only. Application developers should not use this

tc_metric

protected static final java.lang.String tc_metric

See Also:

Constant Field Values

For internal use only. Application developers should not use this

tlp_interior

protected static final java.lang.String tlp_interior

See Also:

Constant Field Values

For internal use only. Application developers should not use this

tlp_exterior

protected static final java.lang.String tlp_exterior

See Also:

Constant Field Values

For internal use only. Application developers should not use this

Constructor Detail

TickLabel

public TickLabel(CommonGauge gauge)

Method Detail

getContent

public int getContent()

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

Returns:

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

setContent

public void setContent(int content)

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

Parameters:

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

convertTickContentToInt

public static int convertTickContentToInt(java.lang.String string)

For internal use only. Application developers should not use this

Converts Tick Content String constants to Integer constants. This is used by get/setXML().

getPosition

public int getPosition()

Gets the tick label position for all gauges in this gauge set.

Returns:

Integer representing the position of the tick label objects.

setPosition

public void setPosition(int position)

Sets the tick label position for all gauges in this gauge set.

Parameters:

position - Integer representing the position

convertTickLabelPositionToInt

public static int convertTickLabelPositionToInt(java.lang.String string)

For internal use only. Application developers should not use this

Converts Position String constants to Integer constants.

getViewFormat

public ViewFormat getViewFormat()

Retrieves a ViewFormat object for tick labels. The ViewFormat objects allow you to format numbers.

Returns:

A ViewFormat object for tick labels.

setViewFormat

public void setViewFormat(ViewFormat viewFormat)

Specifies a ViewFormat object for tick labels. The ViewFormat objects allow you to format numbers.

Parameters:

viewFormat - A ViewFormat object for this label.

getNumberType

public int getNumberType()

Gets the type of number displayed in axis labels of gauge set.

Returns:

Integer representing the type of number intended for display in this gauge; valid values are constants in Gauge beginning with NT_

setNumberType

public void setNumberType(int type)

Sets the type of number to be displayed in axis labels of gauge set.

Parameters:

type - Integer representing the type of number intended for display in this gauge; valid values are constants in the Gauge class beginning with NT_