Package com.microstrategy.web.app.beans

Class GraphTitleInformation

java.lang.Object

com.microstrategy.web.app.beans.GraphTitleInformation

public class GraphTitleInformation
extends java.lang.Object

This class is used for handling the title information for the axis that should be displayed given the current graph major type

Since:

MicroStrategy Web 7.3.1 or earlier

Field Summary

Fields

Modifier and Type	Field	Description
static int	CONTENT_PROPERTY_SUPPORT	Constant for indicating content property is supported by the current graph element
static int	FILL_PROPERTY_SUPPORT	Constant for indicating fill (color) property is supported by the current graph element
static int	FONT_PROPERTY_SUPPORT	Constant for indicating font properties are supported by the current graph element
static int	FONTBOX_PROPERTY_SUPPORT
static int	LEGEND_POSITION_PROPERTY_SUPPORT	Constant for indicating legend position property is supported by the current graph element
static int	LINE_PROPERTY_SUPPORT	Constant for indicating line (color) property is supported by the current graph element
static int	SHOW_PROPERTY_SUPPORT	Constant for indicating show property is supported by the current graph element
static int	TOOLTIP_PROPERTY_SUPPORT

Constructor Summary

Constructors

Constructor	Description
GraphTitleInformation(int objectID)	Class constructor, initializing its properties with the given parameters
GraphTitleInformation(int objectID, int descriptorID, int argumentID)	Deprecated. use the individual set methods instead.

Method Summary

Modifier and Type	Method	Description
int	getArgumentID()	Returns the event argument ID associtaed with this title information instance
int	getDescriptorID()	Returns the descriptor ID associated with this title information instance
java.lang.String	getFilter()
int	getObjectID()	Returns the object ID associated with this title information instance
int	getPropertySupport()
boolean	isComposedFilter()
boolean	isContentSupported()	Deprecated. Please use getPropertySupport() and test for CONTENT_PROPERTY_SUPPORT bit-wise value instead.
boolean	isTypeSupported(int major, int minor)
void	setArgumentID(int value)
void	setDescriptorID(int value)

Methods inherited from class java.lang.Object

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

Field Detail

FONT_PROPERTY_SUPPORT

public static final int FONT_PROPERTY_SUPPORT

Constant for indicating font properties are supported by the current graph element

Since:

MicroStrategy Web 8.0.1

See Also:

Constant Field Values

LINE_PROPERTY_SUPPORT

public static final int LINE_PROPERTY_SUPPORT

Constant for indicating line (color) property is supported by the current graph element

Since:

MicroStrategy Web 8.0.1

See Also:

Constant Field Values

FILL_PROPERTY_SUPPORT

public static final int FILL_PROPERTY_SUPPORT

Constant for indicating fill (color) property is supported by the current graph element

Since:

MicroStrategy Web 8.0.1

See Also:

Constant Field Values

CONTENT_PROPERTY_SUPPORT

public static final int CONTENT_PROPERTY_SUPPORT

Constant for indicating content property is supported by the current graph element

Since:

MicroStrategy Web 8.0.1

See Also:

Constant Field Values

SHOW_PROPERTY_SUPPORT

public static final int SHOW_PROPERTY_SUPPORT

Constant for indicating show property is supported by the current graph element

Since:

MicroStrategy Web 8.0.1

See Also:

Constant Field Values

LEGEND_POSITION_PROPERTY_SUPPORT

public static final int LEGEND_POSITION_PROPERTY_SUPPORT

Constant for indicating legend position property is supported by the current graph element

Since:

MicroStrategy Web 8.0.1

See Also:

Constant Field Values

TOOLTIP_PROPERTY_SUPPORT

public static final int TOOLTIP_PROPERTY_SUPPORT

Since:

MicroStrategy Web 8.1.0

See Also:

Constant Field Values

FONTBOX_PROPERTY_SUPPORT

public static final int FONTBOX_PROPERTY_SUPPORT

Since:

MicroStrategy Web 9.0.0

See Also:

Constant Field Values

Constructor Detail

GraphTitleInformation

public GraphTitleInformation(int objectID,
                             int descriptorID,
                             int argumentID)

Deprecated.

use the individual set methods instead. The values defined for descriptor and argument will not be considered when initializing this instance.

Class constructor, initializing its properties with the given parameters

Parameters:

descriptorID - identifier of the descriptor to use for this title.

argumentID - identifier of the event argument for this title.

objectID - identifier of the object that represents this title.

GraphTitleInformation

public GraphTitleInformation(int objectID)

Class constructor, initializing its properties with the given parameters

Parameters:

objectID - identifier of the descriptor to use for this title.

Since:

MicroStrategy Web 8.0.0

Method Detail

getObjectID

public int getObjectID()

Returns the object ID associated with this title information instance

Returns:

the value of the object ID property

getDescriptorID

public int getDescriptorID()

Returns the descriptor ID associated with this title information instance

Returns:

the value of the descriptor ID property

setDescriptorID

public void setDescriptorID(int value)

Since:

MicroStrategy Web 8.0.0

isComposedFilter

public boolean isComposedFilter()

Since:

MicroStrategy Web 8.0.0

getArgumentID

public int getArgumentID()

Returns the event argument ID associtaed with this title information instance

Returns:

the value of the argument ID property

setArgumentID

public void setArgumentID(int value)

Since:

MicroStrategy Web 8.0.0

getFilter

public java.lang.String getFilter()

Since:

MicroStrategy Web 8.0.0

isContentSupported

public boolean isContentSupported()

Deprecated.

Please use getPropertySupport() and test for CONTENT_PROPERTY_SUPPORT bit-wise value instead.

Since:

MicroStrategy Web 8.0.0

getPropertySupport

public int getPropertySupport()

Returns:

int bit-wise value with the information about which properties are supported by this graph element. Values come from the FONT_PROPERTY_SUPPORT, LINE_PROPERTY_SUPPORT, FILL_PROPERTY_SUPPORT, CONTENT_PROPERTY_SUPPORT and SHOW_PROPERTY_SUPPORT constants.

Since:

MicroStrategy Web 8.0.1

isTypeSupported

public boolean isTypeSupported(int major,
                               int minor)

Since:

MicroStrategy Web 8.0.0