com.esri.arcgis.cartoUI
Class DataGraphTLegendProperties

java.lang.Object
  com.esri.arcgis.cartoUI.DataGraphTLegendProperties

All Implemented Interfaces:

IDataGraphTLegendProperties, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class DataGraphTLegendProperties
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IDataGraphTLegendProperties

A container for the display and manipulation of graph legend properties.

Product Availability

Available with ArcGIS Desktop.

See Also:

Serialized Form

Constructor Summary

DataGraphTLegendProperties(Object obj)
Construct a DataGraphTLegendProperties using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

boolean	equals(Object o) Compare this object with another
int	getAlignment() Options in arranging graph legend.
int	getTextStyle() Options in representing values and labels in graph legend.
String	getTitle() Title of the legend.
int	hashCode() the hashcode for this object
boolean	isVisible() Indicates if graph legend is visible.
void	setAlignment(int pAlignment) Options in arranging graph legend.
void	setTextStyle(int style) Options in representing values and labels in graph legend.
void	setTitle(String title) Title of the legend.
void	setVisible(boolean b) Indicates if graph legend is visible.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

DataGraphTLegendProperties

public DataGraphTLegendProperties(Object obj)
                           throws IOException

Construct a DataGraphTLegendProperties using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to DataGraphTLegendProperties.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
DataGraphTLegendProperties o = (DataGraphTLegendProperties)obj; // will not work

DataGraphTLegendProperties o = new DataGraphTLegendProperties(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems DataGraphTLegendProperties theDataGraphTLegendProperties = (DataGraphTLegendProperties) obj;

Method Detail

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

isVisible

public boolean isVisible()
                  throws IOException,
                         AutomationException

Indicates if graph legend is visible.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

isVisible in interface IDataGraphTLegendProperties

Returns:

The b

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVisible

public void setVisible(boolean b)
                throws IOException,
                       AutomationException

Indicates if graph legend is visible.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setVisible in interface IDataGraphTLegendProperties

Parameters:

b - The b (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTitle

public String getTitle()
                throws IOException,
                       AutomationException

Title of the legend.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getTitle in interface IDataGraphTLegendProperties

Returns:

The title

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTitle

public void setTitle(String title)
              throws IOException,
                     AutomationException

Title of the legend.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setTitle in interface IDataGraphTLegendProperties

Parameters:

title - The title (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAlignment

public int getAlignment()
                 throws IOException,
                        AutomationException

Options in arranging graph legend.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getAlignment in interface IDataGraphTLegendProperties

Returns:

A com.esri.arcgis.carto.esriDataGraphTLegendAlignment constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAlignment

public void setAlignment(int pAlignment)
                  throws IOException,
                         AutomationException

Options in arranging graph legend.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setAlignment in interface IDataGraphTLegendProperties

Parameters:

pAlignment - A com.esri.arcgis.carto.esriDataGraphTLegendAlignment constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTextStyle

public int getTextStyle()
                 throws IOException,
                        AutomationException

Options in representing values and labels in graph legend.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getTextStyle in interface IDataGraphTLegendProperties

Returns:

A com.esri.arcgis.carto.esriDataGraphTLegendTextSyle constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTextStyle

public void setTextStyle(int style)
                  throws IOException,
                         AutomationException

Options in representing values and labels in graph legend.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setTextStyle in interface IDataGraphTLegendProperties

Parameters:

style - A com.esri.arcgis.carto.esriDataGraphTLegendTextSyle constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.