oracle.adf.view.faces.bi.component.gantt
Class TimeAxis

java.lang.Object
  javax.faces.component.UIComponent
      org.apache.myfaces.trinidad.component.UIXComponent
          org.apache.myfaces.trinidad.component.UIXComponentBase
              oracle.adf.view.faces.bi.component.gantt.TimeAxis

All Implemented Interfaces:

javax.faces.component.StateHolder

public class TimeAxis
extends org.apache.myfaces.trinidad.component.UIXComponentBase

A TimeAxis control represents the time axis of the Gantt. It must be added as a facet of the Gantt control.

Field Summary

static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	CUSTOMIZATION_ID_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	DONT_PERSIST_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	FORMAT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	INLINE_STYLE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	ORDER_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	PERSIST_KEY
static java.lang.String	SCALE_DAYS Scale of the time axis constant for one day.
static java.lang.String	SCALE_HALFHOURS Scale of the time axis constant for 30 minutes.
static java.lang.String	SCALE_HALFYEARS Scale of the time axis constant for half a year.
static java.lang.String	SCALE_HOURS Scale of the time axis constant for one hour.
static org.apache.myfaces.trinidad.bean.PropertyKey	SCALE_KEY
static java.lang.String	SCALE_MONTHS Scale of the time axis constant for one month.
static java.lang.String	SCALE_QUARTERHOURS Scale of the time axis constant for 15 minutes.
static java.lang.String	SCALE_QUARTERS Scale of the time axis constant for a quarter.
static java.lang.String	SCALE_SIXHOURS Scale of the time axis constant for six hours.
static java.lang.String	SCALE_THREEHOURS Scale of the time axis constant for three hours.
static java.lang.String	SCALE_TWOMONTHS Scale of the time axis constant for two months.
static java.lang.String	SCALE_TWOWEEKS Scale of the time axis constant for two weeks.
static java.lang.String	SCALE_TWOYEARS Scale of the time axis constant for two years.
static java.lang.String	SCALE_WEEKS Scale of the time axis constant for one week.
static java.lang.String	SCALE_YEARS Scale of the time axis constant for one year.
static org.apache.myfaces.trinidad.bean.PropertyKey	STYLE_CLASS_KEY
static org.apache.myfaces.trinidad.bean.FacesBean.Type	TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	VISIBLE_KEY

Fields inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY

Fields inherited from class javax.faces.component.UIComponent

bindings

Constructor Summary

TimeAxis()
Constructs an instance of a TimeAxis.

Method Summary

protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
java.lang.String	getCustomizationId() Deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.
TimeAxisDateFormat	getDateFormat() Retrieves the TimeAxisDateFormat object used for this time axis.
java.lang.String[]	getDontPersist() Gets List of persistent attributes that are restricted from persisting to a registered "Persistent Change Manager".
java.lang.String	getFamily()
java.lang.String	getInlineStyle() Gets the CSS styles to use for this component.
java.lang.String[]	getOrder() Retrieves the order of the time scale.
java.lang.String[]	getPersist() Gets List of persistent attributes that are persisting to a registered "Persistent Change Manager".
java.lang.String	getRendererType()
java.lang.String	getScale() Retrieves the time scale used for this time axis.
java.lang.String	getStyleClass() Gets a CSS style class to use for this component.
boolean	isVisible() Whether the component is visible or not.
void	setCustomizationId(java.lang.String customizationId) Deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.
void	setDateFormat(TimeAxisDateFormat format) Specifies the TimeAxisDateFormat object used for this time axis.
void	setDontPersist(java.lang.String[] dontPersist) Sets List of persistent attributes that are restricted from persisting to a registered "Persistent Change Manager".
void	setInlineStyle(java.lang.String inlineStyle) Sets the CSS styles to use for this component.
void	setOrder(java.lang.String[] order) Specifies the order of the time scale.
void	setPersist(java.lang.String[] persist) Sets List of persistent attributes that are persisting to a registered "Persistent Change Manager".
void	setScale(java.lang.String scale) Specifies the time scale for this time axis.
void	setStyleClass(java.lang.String styleClass) Sets a CSS style class to use for this component.
void	setVisible(boolean visible) Specifies the visibility of the component.

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addFacesListener, broadcast, broadcastToMethodBinding, broadcastToMethodExpression, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getParent, getProperty, getPropertyKey, getRenderer, getRendersChildren, getValueBinding, getValueExpression, invokeOnChildrenComponents, invokeOnComponent, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeAttributeChangeListener, removeFacesListener, restoreState, satisfiesPartialTrigger, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression, toString, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponent

addPartialTarget, encodeFlattenedChild, encodeFlattenedChildren, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setUpEncodingContext, setupVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitTree, visitTree

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getContainerClientId

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

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

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

SCALE_KEY

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

FORMAT_KEY

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

ORDER_KEY

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

INLINE_STYLE_KEY

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

STYLE_CLASS_KEY

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

CUSTOMIZATION_ID_KEY

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

PERSIST_KEY

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

DONT_PERSIST_KEY

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

VISIBLE_KEY

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

SCALE_TWOYEARS

public static final java.lang.String SCALE_TWOYEARS

Scale of the time axis constant for two years.

See Also:

Constant Field Values

SCALE_YEARS

public static final java.lang.String SCALE_YEARS

Scale of the time axis constant for one year.

See Also:

Constant Field Values

SCALE_HALFYEARS

public static final java.lang.String SCALE_HALFYEARS

Scale of the time axis constant for half a year.

See Also:

Constant Field Values

SCALE_QUARTERS

public static final java.lang.String SCALE_QUARTERS

Scale of the time axis constant for a quarter.

See Also:

Constant Field Values

SCALE_TWOMONTHS

public static final java.lang.String SCALE_TWOMONTHS

Scale of the time axis constant for two months.

See Also:

Constant Field Values

SCALE_MONTHS

public static final java.lang.String SCALE_MONTHS

Scale of the time axis constant for one month.

See Also:

Constant Field Values

SCALE_TWOWEEKS

public static final java.lang.String SCALE_TWOWEEKS

Scale of the time axis constant for two weeks.

See Also:

Constant Field Values

SCALE_WEEKS

public static final java.lang.String SCALE_WEEKS

Scale of the time axis constant for one week.

See Also:

Constant Field Values

SCALE_DAYS

public static final java.lang.String SCALE_DAYS

Scale of the time axis constant for one day.

See Also:

Constant Field Values

SCALE_SIXHOURS

public static final java.lang.String SCALE_SIXHOURS

Scale of the time axis constant for six hours.

See Also:

Constant Field Values

SCALE_THREEHOURS

public static final java.lang.String SCALE_THREEHOURS

Scale of the time axis constant for three hours.

See Also:

Constant Field Values

SCALE_HOURS

public static final java.lang.String SCALE_HOURS

Scale of the time axis constant for one hour.

See Also:

Constant Field Values

SCALE_HALFHOURS

public static final java.lang.String SCALE_HALFHOURS

Scale of the time axis constant for 30 minutes.

See Also:

Constant Field Values

SCALE_QUARTERHOURS

public static final java.lang.String SCALE_QUARTERHOURS

Scale of the time axis constant for 15 minutes.

See Also:

Constant Field Values

Constructor Detail

TimeAxis

public TimeAxis()

Constructs an instance of a TimeAxis.

Method Detail

getBeanType

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

Overrides:

getBeanType in class org.apache.myfaces.trinidad.component.UIXComponentBase

getFamily

public java.lang.String getFamily()

Specified by:

getFamily in class org.apache.myfaces.trinidad.component.UIXComponentBase

getRendererType

public java.lang.String getRendererType()

Overrides:

getRendererType in class org.apache.myfaces.trinidad.component.UIXComponentBase

getInlineStyle

public final java.lang.String getInlineStyle()

Gets the CSS styles to use for this component. This is intended for basic style changes; you should use the skinning mechanism if you require any complex style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component. Many components are composed of several DOM elements which may have their own styles applied to them. Defining a style in the inlineStyle may not always give you what you want. For example, if one of the inner DOM elements for this component has a background color specified for it in the skin, setting a background color in the inlineStyle may not provide any visible change (at least for where that inner DOM element exists) because the inner DOM element's background color will win (since that DOM element is essentially layered on top of the root element). In cases like this, you can use a different skin (or define your own) that defines a skinning key for that inner DOM element where its background color is inhibited (e.g. with -tr-inhibit: background-color) or otherwise set to the color you want.

Returns:

the new inlineStyle value

setInlineStyle

public final void setInlineStyle(java.lang.String inlineStyle)

Sets the CSS styles to use for this component. This is intended for basic style changes; you should use the skinning mechanism if you require any complex style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component. Many components are composed of several DOM elements which may have their own styles applied to them. Defining a style in the inlineStyle may not always give you what you want. For example, if one of the inner DOM elements for this component has a background color specified for it in the skin, setting a background color in the inlineStyle may not provide any visible change (at least for where that inner DOM element exists) because the inner DOM element's background color will win (since that DOM element is essentially layered on top of the root element). In cases like this, you can use a different skin (or define your own) that defines a skinning key for that inner DOM element where its background color is inhibited (e.g. with -tr-inhibit: background-color) or otherwise set to the color you want.

Parameters:

inlineStyle - the new inlineStyle value

getStyleClass

public final java.lang.String getStyleClass()

Gets a CSS style class to use for this component.

Returns:

the new styleClass value

setStyleClass

public final void setStyleClass(java.lang.String styleClass)

Sets a CSS style class to use for this component.

Parameters:

styleClass - the new styleClass value

getPersist

public final java.lang.String[] getPersist()

Gets List of persistent attributes that are persisting to a registered "Persistent Change Manager". Persistent attributes, by default, always persist to a session.

Returns:

the new persist value

setPersist

public final void setPersist(java.lang.String[] persist)

Sets List of persistent attributes that are persisting to a registered "Persistent Change Manager". Persistent attributes, by default, always persist to a session.

Parameters:

persist - the new persist value

getDontPersist

public final java.lang.String[] getDontPersist()

Gets List of persistent attributes that are restricted from persisting to a registered "Persistent Change Manager". Persistent attributes would still persist to a session.

Returns:

the new dontPersist value

setDontPersist

public final void setDontPersist(java.lang.String[] dontPersist)

Sets List of persistent attributes that are restricted from persisting to a registered "Persistent Change Manager". Persistent attributes would still persist to a session.

Parameters:

dontPersist - the new dontPersist value

getCustomizationId

@Deprecated
public final java.lang.String getCustomizationId()

Deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.

Returns:

the new customizationId value

setCustomizationId

@Deprecated
public final void setCustomizationId(java.lang.String customizationId)

Deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.

Parameters:

customizationId - the new customizationId value

isVisible

public boolean isVisible()

Whether the component is visible or not.

Returns:

true if the component is visible. false otherwise.

See Also:

setVisible(boolean)

setVisible

public void setVisible(boolean visible)

Specifies the visibility of the component.

Parameters:

scale - The visibility of the component.

getScale

public java.lang.String getScale()

Retrieves the time scale used for this time axis.

Returns:

The time scale used for this time axis.

See Also:

setScale(java.lang.String)

setScale

public void setScale(java.lang.String scale)

Specifies the time scale for this time axis.

Parameters:

scale - The time scale for this time axis.

getOrder

public java.lang.String[] getOrder()

Retrieves the order of the time scale.

Returns:

The order of the time scale for this time axis.

See Also:

setScale(java.lang.String)

setOrder

public void setOrder(java.lang.String[] order)

Specifies the order of the time scale.

Parameters:

order - The order for this time scale.

getDateFormat

public TimeAxisDateFormat getDateFormat()

Retrieves the TimeAxisDateFormat object used for this time axis.

Returns:

The TimeAxisDateFormat object used for this time axis.

See Also:

#setFormat

setDateFormat

public void setDateFormat(TimeAxisDateFormat format)

Specifies the TimeAxisDateFormat object used for this time axis.

Parameters:

format - The TimeAxisDateFormat object used for this time axis.