com.esri.arcgis.trackinganalyst
Class EventAttributeProperties

java.lang.Object
  extended by com.esri.arcgis.trackinganalyst.EventAttributeProperties
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, IEventAttributeProperties, Serializable

public class EventAttributeProperties
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IEventAttributeProperties

A holding component for event attribute properties.

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.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
EventAttributeProperties()
          Constructs a EventAttributeProperties using ArcGIS Engine.
EventAttributeProperties(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
EventAttributeProperties theEventAttributeProperties = (EventAttributeProperties) obj;
 
Method Summary
 ITextElement createTextElement()
          Creates a new text element generated from the ITextSymbol property.
 boolean equals(Object o)
          Compare this object with another
static String getClsid()
          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
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

EventAttributeProperties

public EventAttributeProperties()
                         throws IOException,
                                UnknownHostException
Constructs a EventAttributeProperties using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

EventAttributeProperties

public EventAttributeProperties(Object obj)
                         throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
EventAttributeProperties theEventAttributeProperties = (EventAttributeProperties) obj;

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.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems
Method Detail

getClsid

public static String getClsid()
getClsid.


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

getTextSymbol

public ITextSymbol getTextSymbol()
                          throws IOException,
                                 AutomationException
The text symbol for rendering an eventís selective set of attributes.

Product Availability

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

Specified by:
getTextSymbol in interface IEventAttributeProperties
Returns:
A reference to a com.esri.arcgis.display.ITextSymbol
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTextSymbolByRef

public void setTextSymbolByRef(ITextSymbol pVal)
                        throws IOException,
                               AutomationException
The text symbol for rendering an eventís selective set of attributes.

Product Availability

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

Specified by:
setTextSymbolByRef in interface IEventAttributeProperties
Parameters:
pVal - A reference to a com.esri.arcgis.display.ITextSymbol (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFieldNames

public IStringArray getFieldNames()
                           throws IOException,
                                  AutomationException
The eventís field names whose values will be used generate text when rendering.

Product Availability

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

Specified by:
getFieldNames in interface IEventAttributeProperties
Returns:
A reference to a com.esri.arcgis.system.IStringArray
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFieldNamesByRef

public void setFieldNamesByRef(IStringArray pVal)
                        throws IOException,
                               AutomationException
The eventís field names whose values will be used generate text when rendering.

Product Availability

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

Specified by:
setFieldNamesByRef in interface IEventAttributeProperties
Parameters:
pVal - A reference to a com.esri.arcgis.system.IStringArray (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNumFields

public int getNumFields()
                 throws IOException,
                        AutomationException
The number of fields whose values will be used generate text when rendering when the FieldNames property is empty.

Product Availability

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

Specified by:
getNumFields in interface IEventAttributeProperties
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setNumFields

public void setNumFields(int pVal)
                  throws IOException,
                         AutomationException
The number of fields whose values will be used generate text when rendering when the FieldNames property is empty.

Product Availability

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

Specified by:
setNumFields in interface IEventAttributeProperties
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createTextElement

public ITextElement createTextElement()
                               throws IOException,
                                      AutomationException
Creates a new text element generated from the ITextSymbol property.

Product Availability

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

Specified by:
createTextElement in interface IEventAttributeProperties
Returns:
A reference to a com.esri.arcgis.carto.ITextElement
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isGlobalProperties

public boolean isGlobalProperties()
                           throws IOException,
                                  AutomationException
Indicates if the renderer properties object is the global version obtained from the Tracking Environment vs. a layer specific version.

Product Availability

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

Specified by:
isGlobalProperties in interface IEventAttributeProperties
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setGlobalProperties

public void setGlobalProperties(boolean pVal)
                         throws IOException,
                                AutomationException
Indicates if the renderer properties object is the global version obtained from the Tracking Environment vs. a layer specific version.

Product Availability

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

Specified by:
setGlobalProperties in interface IEventAttributeProperties
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.