oracle.dss.graph

Class Type

java.lang.Object

oracle.dss.graph.Type

public class Type
extends java.lang.Object

A category of graph types, such as bar graphs or pie graphs. The Graph Type panel uses this class and the Subtype class to populate itself.

See Also:

Subtype, oracle.dss.graph.gui.GraphType, oracle.dss.graph.gui.GraphTypeConverterAdapter

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	fileName The name of the file that contains the icon that represents this graph type category.
int	id The ID of this Type.
boolean	is3D Indicates whether this graph type is being displayed with 3-D effect.
java.lang.String	name The text that is displayed in the Graph Types box, next to the icon that represents this graph type category.
java.lang.String	sFileName The name of the file that contains the small icon that represents this graph type category.
java.util.Vector	subtypes The list of graph subtypes that belong to this graph type category.
boolean	supports3D Indicates whether this graph type can be displayed with 3-D effect.
boolean	supportsNon3D Indicates whether this graph type can be displayed without 3-D effect.

Constructor Summary

Constructors

Constructor and Description
Type(int id, java.lang.String name, java.lang.String fileName, java.lang.String sfilename, java.util.Vector subtypes, boolean supports3D, boolean supportsNon3D) Constructor.
Type(int id, java.lang.String name, java.lang.String fileName, java.util.Vector subtypes, boolean supports3D, boolean supportsNon3D) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addSubtype(Subtype subtype) Adds a Subtype object to this graph type category, at the end of the list of available graph subtypes.
void	addSubtype(Subtype subtype, int afterSubtype) Adds a Subtype object to this graph type category at a specified place in the list of available graph subtypes.
protected int	getSubtypeIndex(int subtypeID)
void	removeSubtype(int subtypeID) Removes a given Subtype from the list of available graph subtypes for this graph type category.

Methods inherited from class java.lang.Object

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

Field Detail

id

public int id

The ID of this Type.

fileName

public java.lang.String fileName

The name of the file that contains the icon that represents this graph type category.

sFileName

public java.lang.String sFileName

The name of the file that contains the small icon that represents this graph type category.

name

public java.lang.String name

The text that is displayed in the Graph Types box, next to the icon that represents this graph type category. This is the name of this graph type category.

subtypes

public java.util.Vector subtypes

The list of graph subtypes that belong to this graph type category.

is3D

public boolean is3D

Indicates whether this graph type is being displayed with 3-D effect.

supports3D

public boolean supports3D

Indicates whether this graph type can be displayed with 3-D effect.

supportsNon3D

public boolean supportsNon3D

Indicates whether this graph type can be displayed without 3-D effect.

Constructor Detail

Type

public Type(int id,
    java.lang.String name,
    java.lang.String fileName,
    java.util.Vector subtypes,
    boolean supports3D,
    boolean supportsNon3D)

Constructor. If you construct a Type, you should extend the GraphTypeConverterAdapter.

Parameters:

id - The ID for this Type.

name - The name of the graph type category. For localized software, pass a localized String. This constructor does not call into a resource bundle. Alternately, set the name variable to a localized String.

fileName - The name of the file that contains the icon that represents this graph type category.

subtypes - The list of graph Subtype objects that belong to this Type.

supports3D - true if this graph type can be displayed with 3-D effect, false if it can not.

supportNon3D - true if this graph type can be displayed without 3-D effect, false if it can not.

See Also:

Subtype

Type

public Type(int id,
    java.lang.String name,
    java.lang.String fileName,
    java.lang.String sfilename,
    java.util.Vector subtypes,
    boolean supports3D,
    boolean supportsNon3D)

Constructor.

Parameters:

id - The ID for this Type.

name - The name of the graph type category. For localized software, pass a localized String. This constructor does not call into a resource bundle. Alternately, set the name variable to a localized String.

fileName - The name of the file that contains the icon that represents this graph type category.

sfileName - The name of the file that contains the small icon that represents this graph type category.

subtypes - The list of graph Subtype objects that belong to this Type.

supports3D - true if this graph type can be displayed with 3-D effect, false if it can not.

supportNon3D - true if this graph type can be displayed without 3-D effect, false if it can not.

See Also:

Subtype

Method Detail

addSubtype

public void addSubtype(Subtype subtype,
              int afterSubtype)

Adds a Subtype object to this graph type category at a specified place in the list of available graph subtypes. The subtypes appear in the Graph Subtypes box. A Subtype object contains information about a graph subtype.

Parameters:

subtype - The Subtype object that you want to add to this graph type category.

afterSubtype - The ID of the Subtype that this Type should be inserted after. If afterSubtype is -1, then the Subtype will be put at the end of the list. IDs for existing subtypes are defined in the GraphTypeConverterAdapter class.

See Also:

oracle.dss.graph.gui.GraphTypeConverterAdapter

addSubtype

public void addSubtype(Subtype subtype)

Adds a Subtype object to this graph type category, at the end of the list of available graph subtypes. A Subtype object contains information about a graph subtype.

Parameters:

subtype - The Subtype object that you want to add to this graph type category.

removeSubtype

public void removeSubtype(int subtypeID)

Removes a given Subtype from the list of available graph subtypes for this graph type category. A Subtype object contains information about a graph subtype.

Parameters:

subtypeID - The ID of the subtype to remove. Subtype IDs are defined in the GraphTypeConverterAdapter class.

See Also:

oracle.dss.graph.gui.GraphTypeConverterAdapter

getSubtypeIndex

protected int getSubtypeIndex(int subtypeID)

Parameters:

subtypeID - the ID of the Subtype for which to return the index

Returns:

the index of the Subtype with the given ID in the list

For internal use only. Application developers should not use this

Get the index of the Subtype with the given ID in the list of Subtypes. Returns -1 if no Subtype with the given ID is found in the list.