Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components
11g Release 2 (11.1.2.2.0)

E17492-03


oracle.adf.view.faces.bi.component.graph
Class TimeSelector

java.lang.Object
  extended by oracle.adf.view.faces.bi.component.BIComplexAttributeBase
      extended by oracle.adf.view.faces.bi.component.graph.TimeSelector

All Implemented Interfaces:
javax.faces.component.StateHolder

public class TimeSelector
extends BIComplexAttributeBase

Field Summary
static org.apache.myfaces.trinidad.bean.PropertyKey BORDER_COLOR_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey BORDER_TRANSPARENT_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey EXPLICIT_END_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey EXPLICIT_START_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey FILL_COLOR_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey FILL_TRANSPARENT_KEY
           
protected  java.awt.Color m_defaultBorderColor
           
protected  boolean m_defaultBorderTransparent
           
protected  java.awt.Color m_defaultFillColor
           
protected  boolean m_defaultFillTransparent
           
protected  int m_defaultMode
           
static org.apache.myfaces.trinidad.bean.PropertyKey MODE_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey SFX_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey TIME_SELECTOR_LISTENER_KEY
           
static java.lang.String TIME_SELECTOR_NAME
           
static org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE
           

 

Fields inherited from class oracle.adf.view.faces.bi.component.BIComplexAttributeBase
ID_KEY, m_parent, TRANSIENT_KEY

 

Constructor Summary
TimeSelector()
           

 

Method Summary
protected  org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
           
 java.awt.Color getBorderColor()
          Retrieves the border color of the time selector.
 java.util.Date getExplicitEnd()
          Retrieves the explicit time selector end date.
 java.util.Date getExplicitStart()
          Retrieves the explicit time selector start date.
 java.awt.Color getFillColor()
          Retrieves the fill color of the time selector.
 int getMode()
          Retrieves the time selector mode.
 SpecialEffects getSpecialEffects()
           
 javax.el.MethodExpression getTimeSelectorListener()
          Retrieves the time selector listener
 boolean isBorderTransparent()
          Indicates whether the border color for the time selector is transparent.
 boolean isFillTransparent()
          Indicates whether the fill color for the time selector is transparent.
protected  void resetStyleProperties()
           
 void setBorderColor(java.awt.Color newColor)
          Specifies the border color of the time selector.
 void setBorderTransparent(boolean yesNo)
          Specifies whether the border color for the time selector is transparent.
 void setExplicitEnd(java.util.Date date)
          Specifies the explicit time selector end date for a time axis.
 void setExplicitStart(java.util.Date date)
          Specifies the explicit time selector start date for a time axis.
 void setFillColor(java.awt.Color newColor)
          Specifies the fill color of the time selector.
 void setFillTransparent(boolean yesNo)
          Specifies whether the fill color for the time selector is transparent.
 void setMode(int mode)
          Specifies the time selector mode on a time axis.
 void setMode(java.lang.String mode)
          Specifies the time selector mode on a time axis.
 void setSpecialEffects(SpecialEffects sfx)
           
 void setTimeSelectorListener(javax.el.MethodExpression timeSelectorListener)
          Sets the time selector listener

 

Methods inherited from class oracle.adf.view.faces.bi.component.BIComplexAttributeBase
applyProperties, getBooleanProperty, getFacesBean, getId, getParent, getProperty, getPropertyKey, getSetAttributeIndex, isTransient, isUpdated, processSetAttribute, processSetAttributeAndAdd, restoreState, 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

m_defaultFillColor

protected java.awt.Color m_defaultFillColor

m_defaultBorderColor

protected java.awt.Color m_defaultBorderColor

m_defaultFillTransparent

protected boolean m_defaultFillTransparent

m_defaultBorderTransparent

protected boolean m_defaultBorderTransparent

m_defaultMode

protected int m_defaultMode

TYPE

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

FILL_COLOR_KEY

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

BORDER_COLOR_KEY

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

FILL_TRANSPARENT_KEY

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

BORDER_TRANSPARENT_KEY

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

MODE_KEY

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

EXPLICIT_START_KEY

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

EXPLICIT_END_KEY

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

SFX_KEY

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

TIME_SELECTOR_LISTENER_KEY

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

TIME_SELECTOR_NAME

public static final java.lang.String TIME_SELECTOR_NAME
See Also:
Constant Field Values

Constructor Detail

TimeSelector

public TimeSelector()

Method Detail

setMode

public void setMode(int mode)
Specifies the time selector mode on a time axis. Valid constants are TSM_OFF and TSM_EXPLICIT. The default is TSM_OFF which means do not show the time selector. TSM_EXPLICIT is used for setting explicit time range. On a time axis, you can specify an explicit time range to show up on the time selector using the following methods. setExplicitStart(Date date) setExplicitEnd(Date date) setMode(TSM_EXPLICIT) You have to set all the three methods for the explicit time selector to take effect. Suppose the time axis is showing Jan 2000 to Dec 2000. You can set an explicit time selector range March 2000 - June 2000. Then the the time selector only covers March 2000 - June 2000.
Parameters:
mode - the time selector mode.

setMode

public void setMode(java.lang.String mode)
Specifies the time selector mode on a time axis. Valid constants are OFF and EXPLICIT. The default is OFF which means do not show the time selector. EXPLICIT is used for setting explicit time range. On a time axis, you can specify an explicit time range to show up on the time selector using the following methods. setExplicitStart(Date date) setExplicitEnd(Date date) setMode(EXPLICIT) You have to set all the three methods for the explicit time selector to take effect. Suppose the time axis is showing Jan 2000 to Dec 2000. You can set an explicit time selector range March 2000 - June 2000. Then the the time selector only covers March 2000 - June 2000.
Parameters:
mode - Indicates the mode of the time selector. Valid values are:
  • OFF - (Default) which means do not show the time selector.
  • EXPLICIT - is used for setting explicit time range. On a time axis, you can specify an explicit time range to show up on the time selector.

getMode

public int getMode()
Retrieves the time selector mode. Valid constants are TSM_OFF and TSM_EXPLICIT. Default is TSM_OFF.
Returns:
time selector mode

setExplicitStart

public void setExplicitStart(java.util.Date date)
Specifies the explicit time selector start date for a time axis. You can specify an explicit time range to show up in the time selector using the following methods. setExplicitStart(Date date) setExplicitEnd(Date date) setMode(TSM_EXPLICIT) You have to set all the three methods for the explicit time range to take effect. Suppose the time axis is showing Jan 2000 to Dec 2000. You can set an explicit time range March 2000 - June 2000. Then the the time axis only shows March 2000 - June 2000.
Parameters:
date - explicit time selector start date.

getExplicitStart

public java.util.Date getExplicitStart()
Retrieves the explicit time selector start date.
Returns:
the explicit time selector start date.

setExplicitEnd

public void setExplicitEnd(java.util.Date date)
Specifies the explicit time selector end date for a time axis. You can specify an explicit time range to show up in the time selector using the following methods. setExplicitStart(Date date) setExplicitEnd(Date date) setMode(TSM_EXPLICIT) You have to set all the three methods for the explicit time selector to take effect. Suppose the time axis is showing Jan 2000 to Dec 2000. You can set an explicit time range March 2000 - June 2000. Then the the time selector only covers March 2000 - June 2000.
Parameters:
date - explicit time selector end date.

getExplicitEnd

public java.util.Date getExplicitEnd()
Retrieves the explicit time selector end date.
Returns:
the explicit time selector end date.

getFillColor

public java.awt.Color getFillColor()
Retrieves the fill color of the time selector.
Returns:
The fill color of the time selector.

setFillColor

public void setFillColor(java.awt.Color newColor)
Specifies the fill color of the time selector.
Parameters:
newColor - The fill color of the time selector.

getBorderColor

public java.awt.Color getBorderColor()
Retrieves the border color of the time selector.
Returns:
The border color of the time selector.

setBorderColor

public void setBorderColor(java.awt.Color newColor)
Specifies the border color of the time selector.
Parameters:
newColor - The border color of the time selector.

isFillTransparent

public boolean isFillTransparent()
Indicates whether the fill color for the time selector is transparent. When an attribute is transparent, it is not visible, but you can select it.
Returns:
true if the fill color is transparent, false if the fill color is not transparent.

setFillTransparent

public void setFillTransparent(boolean yesNo)
Specifies whether the fill color for the time selector is transparent. When an attribute is transparent, it is not visible, but you can select it.
Parameters:
yesNo - true to make the fill color transparent, false to make the fill color visible.

isBorderTransparent

public boolean isBorderTransparent()
Indicates whether the border color for the time selector is transparent. When an attribute is transparent, it is not visible, but you can select it.
Returns:
true if the border color is transparent, false if the border color is not transparent.

setBorderTransparent

public void setBorderTransparent(boolean yesNo)
Specifies whether the border color for the time selector is transparent. When an attribute is transparent, it is not visible, but you can select it.
Parameters:
yesNo - true to make the border color transparent, false to make the border color visible.

getSpecialEffects

public SpecialEffects getSpecialEffects()

setSpecialEffects

public void setSpecialEffects(SpecialEffects sfx)

getTimeSelectorListener

public final javax.el.MethodExpression getTimeSelectorListener()
Retrieves the time selector listener
Returns:
a MethodExpression that defines the time selector listener

setTimeSelectorListener

public final void setTimeSelectorListener(javax.el.MethodExpression timeSelectorListener)
Sets the time selector listener
Parameters:
timeSelectorListener - a MethodExpression that defines the time selector listener

resetStyleProperties

protected void resetStyleProperties()

getBeanType

protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
Specified by:
getBeanType in class BIComplexAttributeBase

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components
11g Release 2 (11.1.2.2.0)

E17492-03


Copyright © 1997, 2012, Oracle. All rights reserved.