oracle.adf.view.faces.bi.component.gauge
Class TickLabel

java.lang.Object
  oracle.adf.view.faces.bi.component.BIComplexAttributeBase
      oracle.adf.view.faces.bi.component.gauge.BaseText
          oracle.adf.view.faces.bi.component.gauge.BaseLabel
              oracle.adf.view.faces.bi.component.gauge.TickLabel

All Implemented Interfaces:

javax.faces.component.StateHolder

public class TickLabel
extends BaseLabel

Since:

11.0

Field Summary

static org.apache.myfaces.trinidad.bean.PropertyKey	CONTENT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	NUMBER_FORMAT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	NUMBER_TYPE_KEY
static org.apache.myfaces.trinidad.bean.FacesBean.Type	TYPE

Fields inherited from class oracle.adf.view.faces.bi.component.gauge.BaseLabel

m_defaultPosition, POSITION_KEY

Fields inherited from class oracle.adf.view.faces.bi.component.gauge.BaseText

FONT_COLOR_KEY, GAUGE_FONT_KEY, m_defaultFontColor, m_defaultFontSize, m_defaultFontStyle, m_defaultFontTypeface

Fields inherited from class oracle.adf.view.faces.bi.component.BIComplexAttributeBase

ID_KEY, m_parent, TRANSIENT_KEY

Constructor Summary

TickLabel()

Method Summary

void	applyProperties(java.util.HashMap map) Applications do not need to call this method.
protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
int	getContent() Gets the tick content specification for all gauges in this gauge set.
oracle.adf.view.faces.bi.component.util.NumberFormat	getNumberFormat()
int	getNumberType() Gets the type of number displayed in the tick label.
int	getPosition() Gets the position of the tick labels.
protected void	resetStyleProperties()
void	setContent(int content) Sets the content of tick labels in a gauge.
void	setNumberFormat(oracle.adf.view.faces.bi.component.util.NumberFormat format)
void	setNumberType(int type) Sets the type of number to be displayed in the tick label.
void	setPosition(int pos) Sets the position of the tick labels.

Methods inherited from class oracle.adf.view.faces.bi.component.gauge.BaseText

getGaugeFont, restoreState, setGaugeFont

Methods inherited from class oracle.adf.view.faces.bi.component.BIComplexAttributeBase

getBooleanProperty, getFacesBean, getId, getParent, getProperty, getPropertyKey, getSetAttributeIndex, isTransient, isUpdated, processSetAttribute, processSetAttributeAndAdd, saveState, setBooleanProperty, setId, setParent, setProperty, setTransient, setUpdated

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE

CONTENT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CONTENT_KEY

NUMBER_TYPE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey NUMBER_TYPE_KEY

NUMBER_FORMAT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey NUMBER_FORMAT_KEY

Constructor Detail

TickLabel

public TickLabel()

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 content of tick labels in a gauge.

Parameters:

content - Integer representing the types of tick labels to be displayed; valid constants are in the GaugeConstants class starting with TICK_.

getNumberFormat

public oracle.adf.view.faces.bi.component.util.NumberFormat getNumberFormat()

setNumberFormat

public void setNumberFormat(oracle.adf.view.faces.bi.component.util.NumberFormat format)

getNumberType

public int getNumberType()

Gets the type of number displayed in the tick label.

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 the tick label.

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_

getPosition

public int getPosition()

Gets the position of the tick labels.

Overrides:

getPosition in class BaseLabel

Returns:

Integer representing the position of tick labels on the dial gauge; valid values are constants in the Gauge class beginning with TLP_

setPosition

public void setPosition(int pos)

Sets the position of the tick labels.

Overrides:

setPosition in class BaseLabel

Parameters:

pos - Integer representing the position of tick labels on the gauge; valid values are constants in the Gauge class beginning with TLP_

resetStyleProperties

protected void resetStyleProperties()

Overrides:

resetStyleProperties in class BaseLabel

applyProperties

public void applyProperties(java.util.HashMap map)

Description copied from class: BIComplexAttributeBase

Applications do not need to call this method. This is for internal use.

Overrides:

applyProperties in class BaseText

Parameters:

map - hashMap that contains property value pairs.

getBeanType

protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()

Overrides:

getBeanType in class BaseLabel