com.esri.arcgis.trackinganalyst
Class EventAttributeProperties

java.lang.Object
  com.esri.arcgis.trackinganalyst.EventAttributeProperties

All Implemented Interfaces:

IEventAttributeProperties, java.io.Serializable

public class EventAttributeProperties

extends java.lang.Object

implements IEventAttributeProperties

A holding component for event attribute properties.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Description

This object is a storage object that contains the properties that allow the EnhancedInfoRenderer to know how to draw textual decorations around its center point.

See Also:

Serialized Form

Constructor Summary

EventAttributeProperties()
Constructs a EventAttributeProperties using ArcGIS Engine.

EventAttributeProperties(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Method Summary

ITextElement	createTextElement() Creates a new text element generated from the ITextSymbol property.
boolean	equals(java.lang.Object o) Compare this object with another
IEventAttributeProperties	getAsIEventAttributeProperties() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
static java.lang.String	getClsid()
IStringArray	getFieldNames() The event’s field names whose values will be used generate text when rendering.
int	getNumFields() The number of fields whose values will be used generate text when rendering when the FieldNames property is empty.
ITextSymbol	getTextSymbol() The text symbol for rendering an event’s selective set of attributes.
int	hashCode() the hashcode for this object
boolean	isGlobalProperties() Indicates if the renderer properties object is the global version obtained from the Tracking Environment vs.
void	setFieldNamesByRef(IStringArray pVal) The event’s field names whose values will be used generate text when rendering.
void	setGlobalProperties(boolean pVal) Indicates if the renderer properties object is the global version obtained from the Tracking Environment vs.
void	setNumFields(int pVal) The number of fields whose values will be used generate text when rendering when the FieldNames property is empty.
void	setTextSymbolByRef(ITextSymbol pVal) The text symbol for rendering an event’s selective set of attributes.

Methods inherited from class java.lang.Object

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

Constructor Detail

EventAttributeProperties

public EventAttributeProperties()
                         throws java.io.IOException,
                                java.net.UnknownHostException

Constructs a EventAttributeProperties using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

EventAttributeProperties

public EventAttributeProperties(java.lang.Object obj)
                         throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Construct a EventAttributeProperties using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to EventAttributeProperties.
EventAttributeProperties theEventAttributeProperties = (EventAttributeProperties) obj;

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getAsIEventAttributeProperties

public IEventAttributeProperties getAsIEventAttributeProperties()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

hashCode

public int hashCode()

the hashcode for this object

getTextSymbol

public ITextSymbol getTextSymbol()
                          throws java.io.IOException,
                                 AutomationException

Description copied from interface: IEventAttributeProperties

The text symbol for rendering an event’s selective set of attributes.

Specified by:

getTextSymbol in interface IEventAttributeProperties

Returns:

A reference to a com.esri.arcgis.display.ITextSymbol

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setTextSymbolByRef

public void setTextSymbolByRef(ITextSymbol pVal)
                        throws java.io.IOException,
                               AutomationException

Description copied from interface: IEventAttributeProperties

The text symbol for rendering an event’s selective set of attributes.

Specified by:

setTextSymbolByRef in interface IEventAttributeProperties

Parameters:

pVal - A reference to a com.esri.arcgis.display.ITextSymbol (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFieldNames

public IStringArray getFieldNames()
                           throws java.io.IOException,
                                  AutomationException

Description copied from interface: IEventAttributeProperties

The event’s field names whose values will be used generate text when rendering.

Specified by:

getFieldNames in interface IEventAttributeProperties

Returns:

A reference to a com.esri.arcgis.system.IStringArray

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setFieldNamesByRef

public void setFieldNamesByRef(IStringArray pVal)
                        throws java.io.IOException,
                               AutomationException

Description copied from interface: IEventAttributeProperties

The event’s field names whose values will be used generate text when rendering.

Specified by:

setFieldNamesByRef in interface IEventAttributeProperties

Parameters:

pVal - A reference to a com.esri.arcgis.system.IStringArray (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getNumFields

public int getNumFields()
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IEventAttributeProperties

The number of fields whose values will be used generate text when rendering when the FieldNames property is empty.

Specified by:

getNumFields in interface IEventAttributeProperties

Returns:

The pVal

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setNumFields

public void setNumFields(int pVal)
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IEventAttributeProperties

The number of fields whose values will be used generate text when rendering when the FieldNames property is empty.

Specified by:

setNumFields in interface IEventAttributeProperties

Parameters:

pVal - The pVal (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createTextElement

public ITextElement createTextElement()
                               throws java.io.IOException,
                                      AutomationException

Description copied from interface: IEventAttributeProperties

Creates a new text element generated from the ITextSymbol property.

Specified by:

createTextElement in interface IEventAttributeProperties

Returns:

A reference to a com.esri.arcgis.carto.ITextElement

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

isGlobalProperties

public boolean isGlobalProperties()
                           throws java.io.IOException,
                                  AutomationException

Description copied from interface: IEventAttributeProperties

Indicates if the renderer properties object is the global version obtained from the Tracking Environment vs. a layer specific version.

Specified by:

isGlobalProperties in interface IEventAttributeProperties

Returns:

The pVal

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setGlobalProperties

public void setGlobalProperties(boolean pVal)
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: IEventAttributeProperties

Indicates if the renderer properties object is the global version obtained from the Tracking Environment vs. a layer specific version.

Specified by:

setGlobalProperties in interface IEventAttributeProperties

Parameters:

pVal - The pVal (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.