oracle.dss.graph.managers
Class GraphStyle

java.lang.Object
  oracle.dss.graph.managers.GraphStyle

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Mergeable, MergeableXML

public class GraphStyle
extends java.lang.Object
implements MergeableXML, java.io.Serializable, java.lang.Cloneable

See Also:

Serialized Form

Field Summary

protected static java.lang.String	a_effect
protected static java.lang.String	a_effectUsed
protected static java.lang.String	a_fillColor
protected static java.lang.String	a_fillColorUsed
protected static java.lang.String	a_markerShape
protected static java.lang.String	a_markerShapeUsed
protected static java.lang.String	a_markerVisible
protected static java.lang.String	a_markerVisibleUsed
protected static java.lang.String	GRAPH_STYLE_NAME
protected ErrorHandler	m_eh
protected java.awt.Color	m_fillColor
protected CommonGraph	m_graph
protected int	m_markerShape
protected boolean	m_markerVisible
protected java.util.BitSet	m_propertyUsedFlags
protected static int	NumberOfPropertyBits
protected static java.lang.String	se_gradient
protected static java.lang.String	se_none

Constructor Summary

GraphStyle()
Constructor

GraphStyle(CommonGraph graph)
Constructor

Method Summary

java.lang.Object	clone() Clones this object.
CommonGraph	getCommonGraph()
int	getEffect() Gets the effect applied on the marker This is enabled only for bubble graphs for now and can be used to conditionally make the bubble appear to be flat or 3D.
ErrorHandler	getErrorHandler()
java.awt.Color	getFillColor() Retrieves the color for the marker.
int	getMarkerShape() Retrieves the shape of the marker.
java.util.BitSet	getPropertyUsedFlags()
oracle.dss.util.xml.ObjectNode	getXML(boolean allProperties, boolean emptyElement) Retrieves XML that represents properties and their values in the form of and ObjectNode.
boolean	isAnythingOverridden() Specifies whether any property has been explicitly set.
boolean	isEffectUsed()
boolean	isFillColorUsed() Indicates whether the fillColor property has been explicitly set.
boolean	isMarkerShapeUsed() Indicates whether the MarkerVisible property has been explicitly set.
boolean	isMarkerVisible() Retrieves the visibility of the marker.
boolean	isMarkerVisibleUsed() Indicates whether the MarkerVisible property has been explicitly set.
void	merge(Mergeable style) Merges the specified object with this object.
void	setCommonGraph(CommonGraph graph)
void	setEffect(int effect) Sets the effect which can be used to set a gradient on the markers/bubbles .This is enabled only for bubble graphs for now and can be used to conditionally make the bubble appear to be flat or 3D.
void	setEffectUsed(boolean used)
void	setErrorHandler(ErrorHandler eh) Specifies the error handler for this ViewStyle.
void	setFillColor(java.awt.Color color) Specifies the color for the marker.
void	setFillColorUsed(boolean used) Specifies whether the fillColor property has been explicitly set.
void	setMarkerShape(int shape) Specifies the marker shape.
void	setMarkerShapeUsed(boolean used) Specifies whether the MarkerShape property has been explicitly set.
void	setMarkerVisible(boolean visible) Specifies the visibility of the marker.
void	setMarkerVisibleUsed(boolean used) Specifies whether the MarkerVisible property has been explicitly set.
void	setPropertyUsedFlags(java.util.BitSet bs)
boolean	setXML(oracle.dss.util.xml.ObjectNode node, java.lang.String version, int reset) Specifies XML that represents properties and values.

Methods inherited from class java.lang.Object

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

Field Detail

m_graph

protected CommonGraph m_graph

For internal use only. Application developers should not use this

m_eh

protected ErrorHandler m_eh

For internal use only. Application developers should not use this

m_fillColor

protected java.awt.Color m_fillColor

For internal use only. Application developers should not use this

m_markerVisible

protected boolean m_markerVisible

For internal use only. Application developers should not use this

m_markerShape

protected int m_markerShape

For internal use only. Application developers should not use this

m_propertyUsedFlags

protected java.util.BitSet m_propertyUsedFlags

For internal use only. Application developers should not use this

The BitSet to store the property used bits

NumberOfPropertyBits

protected static int NumberOfPropertyBits

For internal use only. Application developers should not use this

a_fillColor

protected static final java.lang.String a_fillColor

See Also:

Constant Field Values

For internal use only. Application developers should not use this

a_markerVisible

protected static final java.lang.String a_markerVisible

See Also:

Constant Field Values

For internal use only. Application developers should not use this

a_markerShape

protected static final java.lang.String a_markerShape

See Also:

Constant Field Values

For internal use only. Application developers should not use this

a_effect

protected static final java.lang.String a_effect

See Also:

Constant Field Values

For internal use only. Application developers should not use this

a_fillColorUsed

protected static final java.lang.String a_fillColorUsed

See Also:

Constant Field Values

For internal use only. Application developers should not use this

a_markerVisibleUsed

protected static final java.lang.String a_markerVisibleUsed

See Also:

Constant Field Values

For internal use only. Application developers should not use this

a_markerShapeUsed

protected static final java.lang.String a_markerShapeUsed

See Also:

Constant Field Values

For internal use only. Application developers should not use this

a_effectUsed

protected static final java.lang.String a_effectUsed

See Also:

Constant Field Values

For internal use only. Application developers should not use this

GRAPH_STYLE_NAME

protected static final java.lang.String GRAPH_STYLE_NAME

See Also:

Constant Field Values

For internal use only. Application developers should not use this

se_none

protected static final java.lang.String se_none

See Also:

Constant Field Values

For internal use only. Application developers should not use this

se_gradient

protected static final java.lang.String se_gradient

See Also:

Constant Field Values

For internal use only. Application developers should not use this

Constructor Detail

GraphStyle

public GraphStyle()

Constructor

GraphStyle

public GraphStyle(CommonGraph graph)

Constructor

Method Detail

setFillColor

public void setFillColor(java.awt.Color color)

Specifies the color for the marker.

Parameters:

color - The color for the markers.

setEffect

public void setEffect(int effect)

Sets the effect which can be used to set a gradient on the markers/bubbles .This is enabled only for bubble graphs for now and can be used to conditionally make the bubble appear to be flat or 3D.

Parameters:

effect - The effect to be applied which can have two values GraphConstants.SE_NONE orGraphConstants.SE_GRADIENT

getEffect

public int getEffect()

Gets the effect applied on the marker This is enabled only for bubble graphs for now and can be used to conditionally make the bubble appear to be flat or 3D.

getFillColor

public java.awt.Color getFillColor()

Retrieves the color for the marker.

Returns:

The color for the marker.

setMarkerVisible

public void setMarkerVisible(boolean visible)

Specifies the visibility of the marker.

Parameters:

visible - A boolean specifying visibility.

isMarkerVisible

public boolean isMarkerVisible()

Retrieves the visibility of the marker.

Returns:

A boolean indicating visibility.

setMarkerShape

public void setMarkerShape(int shape)

Specifies the marker shape.

Parameters:

shape - An integer representing shape of the marker.

See Also:

BaseGraphComponent#MS_SQUARE, BaseGraphComponent#MS_CIRCLE, BaseGraphComponent#MS_DIAMOND, BaseGraphComponent#MS_PLUS, BaseGraphComponent#MS_TRIANGLE_DOWN, BaseGraphComponent#MS_TRIANGLE_UP

getMarkerShape

public int getMarkerShape()

Retrieves the shape of the marker.

Returns:

An integer indicating shape of the marker.

See Also:

BaseGraphComponent#MS_SQUARE, BaseGraphComponent#MS_CIRCLE, BaseGraphComponent#MS_DIAMOND, BaseGraphComponent#MS_PLUS, BaseGraphComponent#MS_TRIANGLE_DOWN, BaseGraphComponent#MS_TRIANGLE_UP

isAnythingOverridden

public boolean isAnythingOverridden()

Specifies whether any property has been explicitly set.

Specified by:

isAnythingOverridden in interface Mergeable

Parameters:

true - if any property has been set explicitly, even if the set value is the same as the previous value, false if no property has been set.

merge

public void merge(Mergeable style)

Merges the specified object with this object. If both objects set the same property, then the value from the specified object is used.

Specified by:

merge in interface Mergeable

Parameters:

from - The Mergeable object from which to get property values to merge over the property values of this object. Normally from is the Mergeable object from the Rule that applies and is being run.

clone

public java.lang.Object clone()

Clones this object.

Specified by:

clone in interface Mergeable

Overrides:

clone in class java.lang.Object

Returns:

The clone of this object.

getXML

public oracle.dss.util.xml.ObjectNode getXML(boolean allProperties,
                                             boolean emptyElement)

Retrieves XML that represents properties and their values in the form of and ObjectNode.

Specified by:

getXML in interface MergeableXML

Parameters:

allProperties - true to store all property values in XML, false to store only values that are different from default values.

emptyElement - true if an empty element needs to be returned when none of the property values have changed from default. false if null should should be returned when none of the property values have changed from default. This argument is considered only if allProperties is false.

Returns:

XML for the properties and values.

setXML

public boolean setXML(oracle.dss.util.xml.ObjectNode node,
                      java.lang.String version,
                      int reset)

Specifies XML that represents properties and values. This method applies the values of the properties in the XML to this MergeableXML.

Specified by:

setXML in interface MergeableXML

Parameters:

node - ObjectNode that has the properties and their values.

version - The XML version.

reset - A constant that indicates how much to reset when XML is applied. Valid values are listed in the See Also section.

Returns:

true if XML is properly applied, false if the XML cannot be applied.

See Also:

Rule#RESET_NONE, Rule#RESET_XML_PROPERTIES, Rule#RESET_EVERYTHING

setMarkerShapeUsed

public void setMarkerShapeUsed(boolean used)

Specifies whether the MarkerShape property has been explicitly set. This method is called by the setMarkerShape method. When the parameter value of this method is true, the property's value will be used in the merging process.

Parameters:

used - true if the property has been explicitly set, false if the property has not been explicitly set.

isMarkerShapeUsed

public boolean isMarkerShapeUsed()

Indicates whether the MarkerVisible property has been explicitly set. When the return value of this method is true, the property's value will be used in the merging process.

Returns:

true if the property has been explicitly set, if the property has not been explicitly set.

setMarkerVisibleUsed

public void setMarkerVisibleUsed(boolean used)

Specifies whether the MarkerVisible property has been explicitly set. This method is called by the setMarkerVisible method. When the parameter value of this method is true, the property's value will be used in the merging process.

Parameters:

used - true if the property has been explicitly set, false if the property has not been explicitly set.

isMarkerVisibleUsed

public boolean isMarkerVisibleUsed()

Indicates whether the MarkerVisible property has been explicitly set. When the return value of this method is true, the property's value will be used in the merging process.

Returns:

true if the property has been explicitly set, if the property has not been explicitly set.

setFillColorUsed

public void setFillColorUsed(boolean used)

Specifies whether the fillColor property has been explicitly set. This method is called by the setFillColor method. When the parameter value of this method is true, the property's value will be used in the merging process.

Parameters:

used - true if the property has been explicitly set, false if the property has not been explicitly set.

isFillColorUsed

public boolean isFillColorUsed()

Indicates whether the fillColor property has been explicitly set. When the return value of this method is true, the property's value will be used in the merging process.

Returns:

true if the property has been explicitly set, if the property has not been explicitly set.

setEffectUsed

public void setEffectUsed(boolean used)

isEffectUsed

public boolean isEffectUsed()

getPropertyUsedFlags

public java.util.BitSet getPropertyUsedFlags()

For internal use only. Application developers should not use this

setPropertyUsedFlags

public void setPropertyUsedFlags(java.util.BitSet bs)

For internal use only. Application developers should not use this

getCommonGraph

public CommonGraph getCommonGraph()

For internal use only. Application developers should not use this

setCommonGraph

public void setCommonGraph(CommonGraph graph)

For internal use only. Application developers should not use this

setErrorHandler

public void setErrorHandler(ErrorHandler eh)

Specifies the error handler for this ViewStyle. When you set this ViewStyle on a Dataview, the error handler currently set on this ViewStyle will be removed and the ViewStyle will use the error handler set on the Dataview. For operations that you do before you set the ViewStyle on a Dataview, you should call this method to set your own error handler. This handler will then be removed and the error handler of the Dataview will be used instead.

Parameters:

eh - The error handler to use.

getErrorHandler

public ErrorHandler getErrorHandler()

For internal use only. Application developers should not use this

get error handler of viewformat