com.esri.arcgis.controls
Class ARFeature

java.lang.Object
  extended by com.esri.arcgis.controls.ARFeature
All Implemented Interfaces:
IARFeature, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class ARFeature
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IARFeature

COM Class 'ARFeature'. Generated 3/19/2015 1:20:50 PM from 'C:\ArcGIS\COM\esriPublisherControls.olb'

Description 'ARFeature object.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:
Serialized Form

Field Summary
 
Fields inherited from interface com.esri.arcgis.controls.IARFeature
DISPID_1_GET_NAME, DISPID_10_GET_NAME, DISPID_11_GET_NAME, DISPID_11_PUT_NAME, DISPID_13_NAME, DISPID_14_GET_NAME, DISPID_15_GET_NAME, DISPID_2_GET_NAME, DISPID_3_GET_NAME, DISPID_4_GET_NAME, DISPID_5_GET_NAME, DISPID_6_NAME, DISPID_7_NAME, DISPID_8_NAME, DISPID_9_NAME, IID, IID5dfd448f_1a56_4c52_ac4e_2c1cb3e87ec6, xxDummy
 
Constructor Summary
ARFeature(java.lang.Object obj)
          Construct a ARFeature using a reference to such an object returned from ArcGIS Engine or Server.
 
Method Summary
 void centerAt()
          Centers the feature on the map display.
 boolean equals(java.lang.Object o)
          Compare this object with another
 void flash()
          Flashes the feature on the display.
 void flicker()
          Flickers the feature on the display.
 java.lang.Object getCustomProperty()
          A property to associate data with an object.
 java.lang.String getFieldAliasName(int index)
          The alias name of the field.
 int getFieldCount()
          The number of fields in the field collection.
 java.lang.String getFieldName(int index)
          The name of the field.
 int getFieldType(int index)
          The type of field.
 java.lang.Object getInternalObject()
          The internal ArcObjects IFeature object.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 java.lang.Object getValue(java.lang.Object index)
          The value of the field.
 java.lang.String getValueAsString(java.lang.Object index)
          A property to access the value of the specified field as a string.
 int hashCode()
          the hashcode for this object
 void highlight(boolean bHighlight, int color)
          Highlights the feature on the display.
 boolean isFieldAccessible(java.lang.Object index)
          A property that checks if the specified field is accessible.
 void release()
          Release a ARFeature.
 void setCustomProperty(java.lang.Object pVal)
          A property to associate data with an object.
 void zoomTo()
          Zooms the map to display the feature.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ARFeature

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

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

Throws:
java.io.IOException - if there are interop problems ARFeature theARFeature = (ARFeature) obj;
Method Detail

equals

public boolean equals(java.lang.Object o)
Compare this object with another

Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
Deprecated. Internal use only.

Specified by:
getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()
Release a ARFeature.

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

getValue

public java.lang.Object getValue(java.lang.Object index)
                          throws java.io.IOException,
                                 AutomationException
The value of the field.

Specified by:
getValue in interface IARFeature
Parameters:
index - A Variant (in)
Returns:
A Variant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFieldCount

public int getFieldCount()
                  throws java.io.IOException,
                         AutomationException
The number of fields in the field collection.

Specified by:
getFieldCount in interface IARFeature
Returns:
The lCount
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFieldName

public java.lang.String getFieldName(int index)
                              throws java.io.IOException,
                                     AutomationException
The name of the field.

Specified by:
getFieldName in interface IARFeature
Parameters:
index - The index (in)
Returns:
The sName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFieldAliasName

public java.lang.String getFieldAliasName(int index)
                                   throws java.io.IOException,
                                          AutomationException
The alias name of the field.

Specified by:
getFieldAliasName in interface IARFeature
Parameters:
index - The index (in)
Returns:
The sAliasName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFieldType

public int getFieldType(int index)
                 throws java.io.IOException,
                        AutomationException
The type of field.

Specified by:
getFieldType in interface IARFeature
Parameters:
index - The index (in)
Returns:
A com.esri.arcgis.controls.esriARFieldType constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

zoomTo

public void zoomTo()
            throws java.io.IOException,
                   AutomationException
Zooms the map to display the feature.

Specified by:
zoomTo in interface IARFeature
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

centerAt

public void centerAt()
              throws java.io.IOException,
                     AutomationException
Centers the feature on the map display.

Specified by:
centerAt in interface IARFeature
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

flash

public void flash()
           throws java.io.IOException,
                  AutomationException
Flashes the feature on the display.

Specified by:
flash in interface IARFeature
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

flicker

public void flicker()
             throws java.io.IOException,
                    AutomationException
Flickers the feature on the display.

Specified by:
flicker in interface IARFeature
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getInternalObject

public java.lang.Object getInternalObject()
                                   throws java.io.IOException,
                                          AutomationException
The internal ArcObjects IFeature object.

Specified by:
getInternalObject in interface IARFeature
Returns:
A reference to another Object (IUnknown)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCustomProperty

public java.lang.Object getCustomProperty()
                                   throws java.io.IOException,
                                          AutomationException
A property to associate data with an object.

Specified by:
getCustomProperty in interface IARFeature
Returns:
A Variant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCustomProperty

public void setCustomProperty(java.lang.Object pVal)
                       throws java.io.IOException,
                              AutomationException
A property to associate data with an object.

Specified by:
setCustomProperty in interface IARFeature
Parameters:
pVal - A Variant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

highlight

public void highlight(boolean bHighlight,
                      int color)
               throws java.io.IOException,
                      AutomationException
Highlights the feature on the display.

Specified by:
highlight in interface IARFeature
Parameters:
bHighlight - The bHighlight (in)
color - The color (A COM typedef) (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isFieldAccessible

public boolean isFieldAccessible(java.lang.Object index)
                          throws java.io.IOException,
                                 AutomationException
A property that checks if the specified field is accessible.

Specified by:
isFieldAccessible in interface IARFeature
Parameters:
index - A Variant (in)
Returns:
The bAccessible
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getValueAsString

public java.lang.String getValueAsString(java.lang.Object index)
                                  throws java.io.IOException,
                                         AutomationException
A property to access the value of the specified field as a string.

Specified by:
getValueAsString in interface IARFeature
Parameters:
index - A Variant (in)
Returns:
The bsValueAsString
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.