oracle.dss.graph
Class SFX

java.lang.Object
  oracle.dss.dataView.BaseComponentXML
      oracle.dss.graph.SFX

All Implemented Interfaces:

oracle.dss.presutil.GradientSupport

public class SFX
extends BaseComponentXML
implements oracle.dss.presutil.GradientSupport

Allows you to apply attributes for special effects to the graph. You can use special effects on the graph components that have a getSFX method, such as the PlotArea, the LegendArea, and the GraphBackground.

Field Summary

protected static java.lang.String	a_fillType
protected static java.lang.String	a_gradientDirection
protected static java.lang.String	a_gradientNumPins
protected static java.lang.String	a_gradientNumStops
protected static java.lang.String	a_gradientPinLeftColor
protected static java.lang.String	a_gradientPinRightColor
protected static java.lang.String	a_gradientReversed
protected static java.lang.String	a_gradientStopColor
protected static java.lang.String	a_gradientStopPosition
protected static java.lang.String	a_pinIndex
protected static java.lang.String	a_textureDisplayMode
protected static java.lang.String	a_textureURL
protected static int	fillType
protected static int	gradientDirection
protected static int	gradientNumPins
protected static java.lang.String	gradientPinLeftColor
protected static java.lang.String	gradientPinRightColor
protected static java.lang.String	GRADIENTPINSTYLE_NAME
protected static java.lang.String	GRADIENTSTOPSTYLE_NAME
protected CommonGraph	m_commonGraph
protected oracle.dss.graph.pfj.draw.IdentObj	m_frameBottom
protected oracle.dss.graph.pfj.draw.IdentObj	m_frameSide
protected oracle.dss.graph.pfj.draw.IdentObj	m_identObj
protected oracle.dss.graph.pfj.draw.IdentObj	m_identObj2
protected boolean	m_isPlotArea
protected boolean	m_isSeries
protected PFJ	m_pfj
protected static double	position
protected static int	textureDisplayMode

Fields inherited from class oracle.dss.dataView.BaseComponentXML

m_jsfHashMap

Fields inherited from interface oracle.dss.presutil.GradientSupport

a_visualEffects

Constructor Summary

SFX(CommonGraph graph, oracle.dss.graph.pfj.draw.IdentObj identObj)

SFX(CommonGraph graph, oracle.dss.graph.pfj.draw.IdentObj identObj, oracle.dss.graph.pfj.draw.IdentObj identObj2)

Method Summary

static int	_calcReversedGradientDirection(int dir)
protected java.lang.String	getComponentName()
int	getFillType() Retrieves the fill type for the graph, such as color, gradient, and texture.
int	getGradientDirection() Retrieves the gradient direction for the graph.
int	getGradientNumStops() Retrieves the number of stops in the gradient.
java.awt.Color	getGradientStopColor(int index) Retrieves the color of a stop.
double	getGradientStopPosition(int index) Retrieves position of a stop in the gradient of the graph.
protected oracle.dss.util.xml.ObjectNode	getGradientStopStyleXML(boolean allProperties, int stopIndex)
java.lang.String	getTexture() Retrieves either the URL of the file that contains the texture graphic that is displayed in the graph, or the name of the texture Image, depending on the method that was used to specify the texture.
int	getTextureDisplayMode() Retrieves the way that texture is displayed in the graph.
java.lang.String	getTextureURL()
protected oracle.dss.util.xml.ContainerNode	getXML(boolean allProperties, boolean allOverriddenProperties)
boolean	isGradientReversed() Indicates whether the gradient direction is reversed.
protected void	resetStyle()
protected void	resetStyle(oracle.dss.graph.pfj.draw.IdentObj identObj)
void	setFillType(int type) Specifies the fill type for the graph, such as color, gradient, and texture.
void	setGradientDirection(int dir) Specifies the gradient direction for the graph.
void	setGradientNumStops(int numStops) Specifies the number of stops in the gradient of the graph.
void	setGradientReversed(boolean reverse) Specifies whether to reverse the gradient direction.
void	setGradientStopColor(java.awt.Color newColor, int index) Specifies the color of a stop.
void	setGradientStopPosition(double newPos, int index) Sets the position of a stop in a gradient.
void	setTextureDisplayMode(int mode) Specifies the way that texture is displayed in the graph.
void	setTextureImage(java.lang.String imageName, java.awt.Image image) Specifies an image to display as a texture in a graph.
void	setTextureURL(java.lang.String url) Specifies a graphic file to display as a texture in a graph.
protected void	setXML(oracle.dss.util.xml.ContainerNode node, boolean allProperties)

Methods inherited from class oracle.dss.dataView.BaseComponentXML

getNonstyleXML, getStyleXML, getStyleXML, getXML, setNonstyleXML, setNonstyleXML, setStyleXML, setXML, setXML, setXML, setXML

Methods inherited from class java.lang.Object

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

Field Detail

fillType

protected static final int fillType

See Also:

Constant Field Values

For internal use only. Application developers should not use this

gradientDirection

protected static final int gradientDirection

See Also:

Constant Field Values

For internal use only. Application developers should not use this

gradientNumPins

protected static final int gradientNumPins

See Also:

Constant Field Values

For internal use only. Application developers should not use this

textureDisplayMode

protected static final int textureDisplayMode

See Also:

Constant Field Values

For internal use only. Application developers should not use this

position

protected static final double position

See Also:

Constant Field Values

For internal use only. Application developers should not use this

gradientPinLeftColor

protected static final java.lang.String gradientPinLeftColor

See Also:

Constant Field Values

For internal use only. Application developers should not use this

gradientPinRightColor

protected static final java.lang.String gradientPinRightColor

See Also:

Constant Field Values

For internal use only. Application developers should not use this

a_fillType

protected static final java.lang.String a_fillType

See Also:

Constant Field Values

For internal use only. Application developers should not use this

a_gradientDirection

protected static final java.lang.String a_gradientDirection

See Also:

Constant Field Values

For internal use only. Application developers should not use this

a_gradientNumPins

protected static final java.lang.String a_gradientNumPins

See Also:

Constant Field Values

For internal use only. Application developers should not use this

a_textureDisplayMode

protected static final java.lang.String a_textureDisplayMode

See Also:

Constant Field Values

For internal use only. Application developers should not use this

a_pinIndex

protected static final java.lang.String a_pinIndex

See Also:

Constant Field Values

For internal use only. Application developers should not use this

a_gradientPinLeftColor

protected static final java.lang.String a_gradientPinLeftColor

See Also:

Constant Field Values

For internal use only. Application developers should not use this

a_gradientPinRightColor

protected static final java.lang.String a_gradientPinRightColor

See Also:

Constant Field Values

For internal use only. Application developers should not use this

a_textureURL

protected static final java.lang.String a_textureURL

See Also:

Constant Field Values

For internal use only. Application developers should not use this

GRADIENTPINSTYLE_NAME

protected static final java.lang.String GRADIENTPINSTYLE_NAME

See Also:

Constant Field Values

For internal use only. Application developers should not use this

a_gradientStopColor

protected static final java.lang.String a_gradientStopColor

See Also:

Constant Field Values

For internal use only. Application developers should not use this

a_gradientStopPosition

protected static final java.lang.String a_gradientStopPosition

See Also:

Constant Field Values

For internal use only. Application developers should not use this

a_gradientNumStops

protected static final java.lang.String a_gradientNumStops

See Also:

Constant Field Values

For internal use only. Application developers should not use this

a_gradientReversed

protected static final java.lang.String a_gradientReversed

See Also:

Constant Field Values

For internal use only. Application developers should not use this

GRADIENTSTOPSTYLE_NAME

protected static final java.lang.String GRADIENTSTOPSTYLE_NAME

See Also:

Constant Field Values

For internal use only. Application developers should not use this

m_commonGraph

protected CommonGraph m_commonGraph

For internal use only. Application developers should not use this

m_pfj

protected PFJ m_pfj

For internal use only. Application developers should not use this

m_identObj

protected oracle.dss.graph.pfj.draw.IdentObj m_identObj

For internal use only. Application developers should not use this

m_identObj2

protected oracle.dss.graph.pfj.draw.IdentObj m_identObj2

For internal use only. Application developers should not use this

m_frameSide

protected oracle.dss.graph.pfj.draw.IdentObj m_frameSide

For internal use only. Application developers should not use this

m_frameBottom

protected oracle.dss.graph.pfj.draw.IdentObj m_frameBottom

For internal use only. Application developers should not use this

m_isSeries

protected boolean m_isSeries

For internal use only. Application developers should not use this

m_isPlotArea

protected boolean m_isPlotArea

For internal use only. Application developers should not use this

Constructor Detail

SFX

public SFX(CommonGraph graph,
           oracle.dss.graph.pfj.draw.IdentObj identObj)

Parameters:

graph - The graph that this object belongs to.

identObj - The Perspective for Java object that represents the identity of this object. Perspective for Java is a third party package of objects that are used and manipulated by the BI Beans.

For internal use only. Application developers should not use this

Constructor. Application developers should not have to construct this object, because the graph does it automatically.

SFX

public SFX(CommonGraph graph,
           oracle.dss.graph.pfj.draw.IdentObj identObj,
           oracle.dss.graph.pfj.draw.IdentObj identObj2)

Parameters:

graph - The graph that this object belongs to.

identObj - The Perspective for Java object that represents the identity of this object. Perspective for Java is a third party package of objects that are used and manipulated by the BI Beans.

identObj2 - A second Perspective for Java object that represents the identity of this object.

For internal use only. Application developers should not use this

Constructor. Application developers should not have to construct this object, because the graph does it automatically.

Method Detail

getFillType

public int getFillType()

Retrieves the fill type for the graph, such as color, gradient, and texture.

Specified by:

getFillType in interface oracle.dss.presutil.GradientSupport

Returns:

A constant that represents the fill type for the graph. Possible constants are listed in the See Also section.

See Also:

BaseGraphComponent.FT_COLOR, BaseGraphComponent.FT_GRADIENT, BaseGraphComponent.FT_TEXTURE

setFillType

public void setFillType(int type)

Specifies the fill type for the graph, such as color, gradient, and texture.

If you set the FillType to BaseGraphComponent.FT_GRADIENT, then you should set the other gradient properties.

If you set the FillType to BaseGraphComponent.FT_TEXTURE, then you must specify an image to use as the texture, either by calling setTextureURL or setTextureImage.

Specified by:

setFillType in interface oracle.dss.presutil.GradientSupport

Parameters:

type - A constant that represents the fill type for the graph. Valid constants are listed in the See Also section.

See Also:

BaseGraphComponent.FT_COLOR, BaseGraphComponent.FT_GRADIENT, BaseGraphComponent.FT_TEXTURE

getGradientDirection

public int getGradientDirection()

Retrieves the gradient direction for the graph. Gradient direction indicates the direction toward which a solid fill color begins to fade and mix into another color.

Unless the gradient is reversed, it moves from stop 0 to stop 1 and so on, to the total number of stops. For example, if you set the number of stops to 2, set stop 0 to gray and stop 1 to blue, and you set the gradient direction to GD_DOWN, then the top of the gradient will be gray and the bottom will be blue.

You can get an opposite direction by calling setGradientReversed. For example, reversing the previous gradient makes it go up, with gray at the bottom and blue at the top.

Specified by:

getGradientDirection in interface oracle.dss.presutil.GradientSupport

Returns:

A constant that represents the gradient direction for the graph. Possible constants are listed in the See Also section.

See Also:

BaseGraphComponent.GD_DOWN, BaseGraphComponent.GD_RADIAL, BaseGraphComponent.GD_RIGHT, BaseGraphComponent.GD_DIAGONAL_45, BaseGraphComponent.GD_DIAGONAL_135

setGradientDirection

public void setGradientDirection(int dir)

Specifies the gradient direction for the graph. Gradient direction indicates the direction toward which a solid fill color begins to fade and mix into another color.

Unless the gradient is reversed, it moves from stop 0 to stop 1 and so on, to the total number of stops. For example, if you set the number of stops to 2, set stop 0 to gray and stop 1 to blue, and you set the gradient direction to GD_DOWN, then the top of the gradient will be gray and the bottom will be blue.

You can get an opposite direction by calling setGradientReversed. For example, reversing the previous gradient makes it go up, with gray at the bottom and blue at the top.

Note that this method does not call the setGradientReversed method. Given the previous example, if you then set GradientReversed to true, then the gradient will go from gray at the bottom to blue at the top. If you then set the gradient direction to GD_RIGHT, the GradientReversed property remains true, so the gradient will go from right to left instead of from left to right.

Specified by:

setGradientDirection in interface oracle.dss.presutil.GradientSupport

Parameters:

dir - A constant that represents the gradient direction for the graph. Valid constants are listed in the See Also section.

See Also:

setGradientReversed(boolean), BaseGraphComponent.GD_DOWN, BaseGraphComponent.GD_RADIAL, BaseGraphComponent.GD_RIGHT, BaseGraphComponent.GD_DIAGONAL_45, BaseGraphComponent.GD_DIAGONAL_135

getGradientStopColor

public java.awt.Color getGradientStopColor(int index)

Retrieves the color of a stop.

Specified by:

getGradientStopColor in interface oracle.dss.presutil.GradientSupport

Parameters:

index - The index of the stop whose color you want. The first stop is stop 0.

Returns:

The color of the specified stop.

setGradientStopColor

public void setGradientStopColor(java.awt.Color newColor,
                                 int index)

Specifies the color of a stop.

Specified by:

setGradientStopColor in interface oracle.dss.presutil.GradientSupport

Parameters:

newColor - The color for the stop.

index - The index of the stop whose color to set. The first stop is stop 0.

getGradientStopPosition

public double getGradientStopPosition(int index)

Retrieves position of a stop in the gradient of the graph. The 0 position is at the start of the gradient. The 100 position is at the end of the gradient.

For example, if the gradient direction is GD_DOWN, and the position for stop 0 is 0, then the color for stop 0 appears at the top of the gradient. If the position for stop 1 is 50, then the color for stop 1 appears in the middle of the gradient. If the position for stop 2 is 100, then the color for stop 2 appears at the bottom of the gradient.

If GradientReversed is true, however, position 0 is at the end of the gradient, and position 100 is at the start.

Specified by:

getGradientStopPosition in interface oracle.dss.presutil.GradientSupport

Parameters:

index - The index of this stop.

Returns:

The position of the stop in the gradient. Valid values are from 0 - 100.

setGradientStopPosition

public void setGradientStopPosition(double newPos,
                                    int index)

Sets the position of a stop in a gradient. The 0 position is at the start of the gradient. The 100 position is at the end of the gradient. For example, if the gradient direction is GD_DOWN, and the position for stop 0 is 0, then the color for stop 0 appears at the top of the gradient. If the position for stop 1 is 50, then the color for stop 1 appears in the middle of the gradient. If the position for stop 2 is 100, then the color for stop 2 appears at the bottom of the gradient.

If GradientReversed is true, however, position 0 is at the end of the gradient, and position 100 is at the start.

Specified by:

setGradientStopPosition in interface oracle.dss.presutil.GradientSupport

Parameters:

index - The index of the stop whose position to set.

newPos - The position of the specified stop in the gradient. Valid values are from 0 - 100.

getGradientNumStops

public int getGradientNumStops()

Retrieves the number of stops in the gradient. A stop represents a color in the gradient.

Specified by:

getGradientNumStops in interface oracle.dss.presutil.GradientSupport

Returns:

The number of stops in the gradient.

setGradientNumStops

public void setGradientNumStops(int numStops)

Specifies the number of stops in the gradient of the graph. Each stop represents a color in the gradient.

Whenever you call this method, the graph positions stops equidistant from each other, with the first and the last stops at the extreme edges. The stops are repositioned without regard for their current position.

Specified by:

setGradientNumStops in interface oracle.dss.presutil.GradientSupport

Parameters:

numStops - The number of stops in the gradient of the graph.

setGradientReversed

public void setGradientReversed(boolean reverse)

Specifies whether to reverse the gradient direction. When the gradient direction is reversed, the gradient starts with the last stop and ends with stop 0.

This method provides opposite directions for the available gradient directions except GD_RADIAL. For example, to have a gradient go up, set the gradient type to BaseGraphComponent.GD_DOWN, and then pass true to this method.

Specified by:

setGradientReversed in interface oracle.dss.presutil.GradientSupport

Parameters:

reverse - true to reverse the direction of the gradient, false to use the GradientDirection property value as is.

See Also:

setGradientDirection(int)

_calcReversedGradientDirection

public static int _calcReversedGradientDirection(int dir)

Parameters:

dir - the gradient direction to find the reverse for

Returns:

the reverse gradient direction of the given one; returns the given one if no reverse can be calculated

For internal use only. Application developers should not use this

Calculate the reverse gradient direction for the given gradient direction.

isGradientReversed

public boolean isGradientReversed()

Indicates whether the gradient direction is reversed. When the gradient direction is reversed, the gradient starts with the last stop and ends with stop 0.

Reversing the gradient direction increases the number of possible directions. For example, reversing the direction of GD_DOWN produces a gradient that goes up.

Returns:

boolean true if the direction is reversed, false if it is not.

getTextureDisplayMode

public int getTextureDisplayMode()

Retrieves the way that texture is displayed in the graph. The texture graphic is either stretched or tiled to fit the area that it is displayed in.

Returns:

A constant that represents the way that texture is displayed in the graph. Valid constants are listed in the See Also section.

See Also:

BaseGraphComponent.TDM_TILED, BaseGraphComponent.TDM_STRETCHED

setTextureDisplayMode

public void setTextureDisplayMode(int mode)

Specifies the way that texture is displayed in the graph. The texture graphic is either stretched or tiled to fit the area that it is displayed in.

Parameters:

mode - A constant that represents the the way that texture is display in the graph. Valid constants are listed in the See Also section.

See Also:

BaseGraphComponent.TDM_TILED, BaseGraphComponent.TDM_STRETCHED

getTexture

public java.lang.String getTexture()

Retrieves either the URL of the file that contains the texture graphic that is displayed in the graph, or the name of the texture Image, depending on the method that was used to specify the texture. If the setTextureURL method was used to specify the texture, then this method's return value will be the URL of the file that contains the texture graphic. If the setTextureImage method was used to specify the texture, then this method's return value will be the name of the texture graphic itself.

Returns:

Either the URL of the file that contains the texture graphic, or the name of the texture Image, depending on the method that was used to set the texture.

See Also:

setTextureURL(java.lang.String), setTextureImage(java.lang.String, java.awt.Image)

getTextureURL

public java.lang.String getTextureURL()

Returns:

the URL of the file that contains the texture graphic.

See Also:

setTextureURL(java.lang.String)

For internal use only. Application developers should not use this

Retrieves the URL of the file that contains the texture graphic that is displayed in the graph

setTextureURL

public void setTextureURL(java.lang.String url)

Specifies a graphic file to display as a texture in a graph. The specified graphic is displayed only when the FillType property is set to FT_TEXTURE.

Parameters:

url - The URL for the file that contains the texture graphic that is displayed in the graph. If the URL does not point to a graphic file, then a runtime exception is thrown, and the graph is not displayed.

See Also:

setFillType(int), setTextureDisplayMode(int)

setTextureImage

public void setTextureImage(java.lang.String imageName,
                            java.awt.Image image)

Specifies an image to display as a texture in a graph. The specified image is displayed only when the FillType property is set to FT_TEXTURE.

The image that you set in this method is not stored with the XML for the graph. You must arrange for the image to be available to the deployed graph. You should call this method after you set XML on the graph.

Parameters:

imageName - A name for the Image.

image - The Image to display as a texture.

See Also:

setFillType(int), setTextureDisplayMode(int)

getComponentName

protected java.lang.String getComponentName()

Overrides:

getComponentName in class BaseComponentXML

For internal use only. Application developers should not use this

Retrieves the name of the title.

getGradientStopStyleXML

protected oracle.dss.util.xml.ObjectNode getGradientStopStyleXML(boolean allProperties,
                                                                 int stopIndex)

For internal use only. Application developers should not use this

resetStyle

protected void resetStyle()

For internal use only. Application developers should not use this

reset style properties

resetStyle

protected void resetStyle(oracle.dss.graph.pfj.draw.IdentObj identObj)

For internal use only. Application developers should not use this

reset style properties

getXML

protected oracle.dss.util.xml.ContainerNode getXML(boolean allProperties,
                                                   boolean allOverriddenProperties)

For internal use only. Application developers should not use this

Retrieves XML from this component

setXML

protected void setXML(oracle.dss.util.xml.ContainerNode node,
                      boolean allProperties)

For internal use only. Application developers should not use this

if allProperties is true, setXML else setStyleXML