oracle.adfdt.view.dvt.binding.pattern.gauge.extension

Class LedGaugeExtendedProperties

java.lang.Object

oracle.adfdt.view.dvt.binding.pattern.options.ComplexExtendedProperties

oracle.adfdt.view.dvt.binding.pattern.gauge.extension.LedGaugeExtendedProperties

All Implemented Interfaces:

ExtendedProperties

public class LedGaugeExtendedProperties
extends ComplexExtendedProperties

A set of accessor methods that allow the user to change the structure and functionality of a ledGauge.

Field Summary

Fields inherited from class oracle.adfdt.view.dvt.binding.pattern.options.ComplexExtendedProperties

AF_NS, DVT_NS, F_NS

Constructor Summary

Constructors

Constructor and Description
LedGaugeExtendedProperties()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getBinding() Description: Specifies a binding reference to store a specific instance of UILedGauge from a backing bean.
java.lang.String	getBorderColor() Description: Specifies the border color of the gauge indicator.
java.lang.String	getColor() Description: Specifies the fill color of the gauge indicator.
java.lang.String	getEmptyText() Description: The text of the component when empty.
GaugeMetricLabel	getGaugeMetricLabel() Description: Defines properties for the gauge metric label.
java.lang.String	getId() Description: Specifies the identifier for the component
java.lang.String	getInlineStyle() Description: Style of the outer element (enclosing div) of the component
java.lang.Number	getMaximum() Description: The maximum value for the gauge.
java.lang.String	getMaximumAsString() Description: The maximum value for the gauge.
java.lang.Number	getMinimum() Description: The minimum value for the gauge.
java.lang.String	getMinimumAsString() Description: The minimum value for the gauge.
java.lang.String[]	getPartialTriggers() Description: The IDs of the components that should trigger a partial update.
java.lang.Number	getRotation() Description: Specifies the rotation angle for the gauge, which is useful for changing the direction of arrow and triangle gauges.
java.lang.String	getShortDesc() Description: The short description of this component.
java.lang.Number	getSize() Description: The relative size of the LED gauge shape.
java.lang.String	getSizeAsString() Description: The relative size of the LED gauge shape.
java.lang.String	getStyleClass() Description: Sets a CSS style class to use for this component.
java.lang.String	getTagName()
java.lang.String	getType() Description: Specifies the shape of the LED gauge.
java.lang.Number	getValue() Description: The metric value for the gauge.
java.lang.String	getValueAsString() Description: The metric value for the gauge.
java.lang.String	getVisualEffects() Description: Specifies whether visual effects such as gradients and overlays are enabled.
boolean	isRendered() Description: Specifies whether the component is rendered.
java.lang.String	isRenderedAsString() Description: Specifies whether the component is rendered.
void	setBinding(java.lang.String binding) Description: Specifies a binding reference to store a specific instance of UILedGauge from a backing bean.
void	setBorderColor(java.lang.String borderColor) Description: Specifies the border color of the gauge indicator.
void	setColor(java.lang.String color) Description: Specifies the fill color of the gauge indicator.
void	setEmptyText(java.lang.String emptyText) Description: The text of the component when empty.
void	setGaugeMetricLabel(GaugeMetricLabel gaugeMetricLabel) Description: Defines properties for the gauge metric label.
void	setId(java.lang.String id) Description: Specifies the identifier for the component
void	setInlineStyle(java.lang.String inlineStyle) Description: Style of the outer element (enclosing div) of the component
void	setMaximum(java.lang.Number maximum) Description: The maximum value for the gauge.
void	setMaximumAsString(java.lang.String maximum) Description: The maximum value for the gauge.
void	setMinimum(java.lang.Number minimum) Description: The minimum value for the gauge.
void	setMinimumAsString(java.lang.String minimum) Description: The minimum value for the gauge.
void	setPartialTriggers(java.lang.String[] partialTriggers) Description: The IDs of the components that should trigger a partial update.
void	setRendered(boolean rendered) Description: Specifies whether the component is rendered.
void	setRenderedAsString(java.lang.String rendered) Description: Specifies whether the component is rendered.
void	setRotation(java.lang.Number rotation) Description: Specifies the rotation angle for the gauge, which is useful for changing the direction of arrow and triangle gauges.
void	setShortDesc(java.lang.String shortDesc) Description: The short description of this component.
void	setSize(java.lang.Number size) Description: The relative size of the LED gauge shape.
void	setSizeAsString(java.lang.String size) Description: The relative size of the LED gauge shape.
void	setStyleClass(java.lang.String styleClass) Description: Sets a CSS style class to use for this component.
void	setType(java.lang.String type) Description: Specifies the shape of the LED gauge.
void	setValue(java.lang.Number value) Description: The metric value for the gauge.
void	setValueAsString(java.lang.String value) Description: The metric value for the gauge.
void	setVisualEffects(java.lang.String visualEffects) Description: Specifies whether visual effects such as gradients and overlays are enabled.

Methods inherited from class oracle.adfdt.view.dvt.binding.pattern.options.ComplexExtendedProperties

_applyToRootElement, _applyToRootElement, applyChanges, applyChanges, applyChanges, applyChanges, applyChanges, cloneFrom, getAttribute, getComplexChild, getComplexChild, getComplexChildAsList, populateAttributesAndChildTags, removeComplexChildList, setAttribute, setComplexChild, setComplexChild, setComplexChildAsList

Methods inherited from class java.lang.Object

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

Constructor Detail

LedGaugeExtendedProperties

public LedGaugeExtendedProperties()

Method Detail

getTagName

public java.lang.String getTagName()

Specified by:

getTagName in class ComplexExtendedProperties

getBinding

public java.lang.String getBinding()

Description: Specifies a binding reference to store a specific instance of UILedGauge from a backing bean. Set this attribute only to access code in a backing bean. For example, to reference a gauge component in the sample managed bean, use the following code: binding="#{sample.gauge}"

Returns:

the value of the binding attribute of the Tag this class represents.

setBinding

public void setBinding(java.lang.String binding)

Description: Specifies a binding reference to store a specific instance of UILedGauge from a backing bean. Set this attribute only to access code in a backing bean. For example, to reference a gauge component in the sample managed bean, use the following code: binding="#{sample.gauge}"

Parameters:

binding - the value of the binding attribute of the Tag this class represents.

getBorderColor

public java.lang.String getBorderColor()

Description: Specifies the border color of the gauge indicator. Valid values are RGB hexadecimal.

Returns:

the value of the borderColor attribute of the Tag this class represents.

setBorderColor

public void setBorderColor(java.lang.String borderColor)

Description: Specifies the border color of the gauge indicator. Valid values are RGB hexadecimal.

Parameters:

borderColor - the value of the borderColor attribute of the Tag this class represents.

getColor

public java.lang.String getColor()

Description: Specifies the fill color of the gauge indicator. Valid values are RGB hexadecimal.

Returns:

the value of the color attribute of the Tag this class represents.

setColor

public void setColor(java.lang.String color)

Description: Specifies the fill color of the gauge indicator. Valid values are RGB hexadecimal.

Parameters:

color - the value of the color attribute of the Tag this class represents.

getEmptyText

public java.lang.String getEmptyText()

Description: The text of the component when empty.

Returns:

the value of the emptyText attribute of the Tag this class represents.

setEmptyText

public void setEmptyText(java.lang.String emptyText)

Description: The text of the component when empty.

Parameters:

emptyText - the value of the emptyText attribute of the Tag this class represents.

getId

public java.lang.String getId()

Description: Specifies the identifier for the component

Returns:

the value of the id attribute of the Tag this class represents.

setId

public void setId(java.lang.String id)

Description: Specifies the identifier for the component

Parameters:

id - the value of the id attribute of the Tag this class represents.

getInlineStyle

public java.lang.String getInlineStyle()

Description: Style of the outer element (enclosing div) of the component

Returns:

the value of the inlineStyle attribute of the Tag this class represents.

setInlineStyle

public void setInlineStyle(java.lang.String inlineStyle)

Description: Style of the outer element (enclosing div) of the component

Parameters:

inlineStyle - the value of the inlineStyle attribute of the Tag this class represents.

getMaximum

public java.lang.Number getMaximum()

Description: The maximum value for the gauge.

Returns:

the value of the maximum attribute of the Tag this class represents.

setMaximum

public void setMaximum(java.lang.Number maximum)

Description: The maximum value for the gauge.

Parameters:

maximum - the value of the maximum attribute of the Tag this class represents.

getMaximumAsString

public java.lang.String getMaximumAsString()

Description: The maximum value for the gauge. This method is provided as a convenience to be able to retrieve an EL that was set on the maximum attribute.

Returns:

the value of the maximum attribute of the Tag this class represents.

setMaximumAsString

public void setMaximumAsString(java.lang.String maximum)

Description: The maximum value for the gauge. This method is provided as a convenience to be able to set an EL on the maximum attribute.

Parameters:

maximum - the value of the maximum attribute of the Tag this class represents.

getMinimum

public java.lang.Number getMinimum()

Description: The minimum value for the gauge.

Returns:

the value of the minimum attribute of the Tag this class represents.

setMinimum

public void setMinimum(java.lang.Number minimum)

Description: The minimum value for the gauge.

Parameters:

minimum - the value of the minimum attribute of the Tag this class represents.

getMinimumAsString

public java.lang.String getMinimumAsString()

Description: The minimum value for the gauge. This method is provided as a convenience to be able to retrieve an EL that was set on the minimum attribute.

Returns:

the value of the minimum attribute of the Tag this class represents.

setMinimumAsString

public void setMinimumAsString(java.lang.String minimum)

Description: The minimum value for the gauge. This method is provided as a convenience to be able to set an EL on the minimum attribute.

Parameters:

minimum - the value of the minimum attribute of the Tag this class represents.

getPartialTriggers

public java.lang.String[] getPartialTriggers()

Description: The IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too.

Returns:

the value of the partialTriggers attribute of the Tag this class represents.

setPartialTriggers

public void setPartialTriggers(java.lang.String[] partialTriggers)

Description: The IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too.

Parameters:

partialTriggers - the value of the partialTriggers attribute of the Tag this class represents.

isRendered

public boolean isRendered()

Description: Specifies whether the component is rendered.

Returns:

the value of the rendered attribute of the Tag this class represents.

setRendered

public void setRendered(boolean rendered)

Description: Specifies whether the component is rendered.

Parameters:

rendered - the value of the rendered attribute of the Tag this class represents.

isRenderedAsString

public java.lang.String isRenderedAsString()

Description: Specifies whether the component is rendered. This method is provided as a convenience to be able to retrieve an EL that was set on the rendered attribute.

Returns:

the value of the rendered attribute of the Tag this class represents.

setRenderedAsString

public void setRenderedAsString(java.lang.String rendered)

Description: Specifies whether the component is rendered. This method is provided as a convenience to be able to set an EL on the rendered attribute.

Parameters:

rendered - the value of the rendered attribute of the Tag this class represents.

getRotation

public java.lang.Number getRotation()

Description: Specifies the rotation angle for the gauge, which is useful for changing the direction of arrow and triangle gauges.

Returns:

the value of the rotation attribute of the Tag this class represents.

setRotation

public void setRotation(java.lang.Number rotation)

Description: Specifies the rotation angle for the gauge, which is useful for changing the direction of arrow and triangle gauges.

Parameters:

rotation - the value of the rotation attribute of the Tag this class represents.

getShortDesc

public java.lang.String getShortDesc()

Description: The short description of this component. This is used to customize the tooltip text.

Returns:

the value of the shortDesc attribute of the Tag this class represents.

setShortDesc

public void setShortDesc(java.lang.String shortDesc)

Description: The short description of this component. This is used to customize the tooltip text.

Parameters:

shortDesc - the value of the shortDesc attribute of the Tag this class represents.

getSize

public java.lang.Number getSize()

Description: The relative size of the LED gauge shape. Valid values range from 0 to 1 (default).

Returns:

the value of the size attribute of the Tag this class represents.

setSize

public void setSize(java.lang.Number size)

Description: The relative size of the LED gauge shape. Valid values range from 0 to 1 (default).

Parameters:

size - the value of the size attribute of the Tag this class represents.

getSizeAsString

public java.lang.String getSizeAsString()

Description: The relative size of the LED gauge shape. Valid values range from 0 to 1 (default). This method is provided as a convenience to be able to retrieve an EL that was set on the size attribute.

Returns:

the value of the size attribute of the Tag this class represents.

setSizeAsString

public void setSizeAsString(java.lang.String size)

Description: The relative size of the LED gauge shape. Valid values range from 0 to 1 (default). This method is provided as a convenience to be able to set an EL on the size attribute.

Parameters:

size - the value of the size attribute of the Tag this class represents.

getStyleClass

public java.lang.String getStyleClass()

Description: Sets a CSS style class to use for this component.

Returns:

the value of the styleClass attribute of the Tag this class represents.

setStyleClass

public void setStyleClass(java.lang.String styleClass)

Description: Sets a CSS style class to use for this component.

Parameters:

styleClass - the value of the styleClass attribute of the Tag this class represents.

getType

public java.lang.String getType()

Description: Specifies the shape of the LED gauge.

Returns:

the value of the type attribute of the Tag this class represents.

setType

public void setType(java.lang.String type)

Description: Specifies the shape of the LED gauge.

Parameters:

type - the value of the type attribute of the Tag this class represents.

getValue

public java.lang.Number getValue()

Description: The metric value for the gauge.

Returns:

the value of the value attribute of the Tag this class represents.

setValue

public void setValue(java.lang.Number value)

Description: The metric value for the gauge.

Parameters:

value - the value of the value attribute of the Tag this class represents.

getValueAsString

public java.lang.String getValueAsString()

Description: The metric value for the gauge. This method is provided as a convenience to be able to retrieve an EL that was set on the value attribute.

Returns:

the value of the value attribute of the Tag this class represents.

setValueAsString

public void setValueAsString(java.lang.String value)

Description: The metric value for the gauge. This method is provided as a convenience to be able to set an EL on the value attribute.

Parameters:

value - the value of the value attribute of the Tag this class represents.

getVisualEffects

public java.lang.String getVisualEffects()

Description: Specifies whether visual effects such as gradients and overlays are enabled.

Returns:

the value of the visualEffects attribute of the Tag this class represents.

setVisualEffects

public void setVisualEffects(java.lang.String visualEffects)

Description: Specifies whether visual effects such as gradients and overlays are enabled.

Parameters:

visualEffects - the value of the visualEffects attribute of the Tag this class represents.

getGaugeMetricLabel

public GaugeMetricLabel getGaugeMetricLabel()

Description: Defines properties for the gauge metric label.

Returns:

the GaugeMetricLabel of the Tag this class represents.

setGaugeMetricLabel

public void setGaugeMetricLabel(GaugeMetricLabel gaugeMetricLabel)

Description: Defines properties for the gauge metric label.

Parameters:

gaugeMetricLabel - the GaugeMetricLabel of the Tag this class represents.