com.esri.arcgis.arcmapui
Class TableProperties

java.lang.Object
  extended by com.esri.arcgis.arcmapui.TableProperties
All Implemented Interfaces:
IDocumentEvents, IEnumTableProperties, ITableProperties, IActiveViewEvents, IDefaultTableProperty, ITableCalculator, ITableCharacteristics, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, java.io.Externalizable, java.io.Serializable, java.util.EventListener

public class TableProperties
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ITableProperties, IDefaultTableProperty, ITableCharacteristics, ITableCalculator, IEnumTableProperties, IClone, IPersist, IPersistStream, IDocumentEvents, IActiveViewEvents, java.io.Externalizable

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

Description 'Table window properties.' 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
static long serialVersionUID
           
 
Fields inherited from interface com.esri.arcgis.arcmapui.ITableProperties
IID, IID4657d94e_5ffb_11d3_9f6c_00c04f6bc886, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabaseui.IDefaultTableProperty
IID, IID4657d94f_5ffb_11d3_9f6c_00c04f6bc886, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabaseui.ITableCharacteristics
IID, IIDbb16ff23_f083_4191_b921_6291ca3b512f, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabaseui.ITableCalculator
IID, IID1c1b8ce1_d23b_4ede_9a0e_2f65af61f1d1, xxDummy
 
Fields inherited from interface com.esri.arcgis.arcmapui.IEnumTableProperties
IID, IID4657d953_5ffb_11d3_9f6c_00c04f6bc886, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IClone
IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IPersistStream
IID, IID00000109_0000_0000_c000_000000000046, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IPersist
IID0000010c_0000_0000_c000_000000000046
 
Fields inherited from interface com.esri.arcgis.arcmapui.IDocumentEvents
IID, IID6db7c4bd_0a7c_11d1_86aa_0000f8751720, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IActiveViewEvents
IID, IIDe79c5940_52dd_11d0_98be_00805f7ced21, xxDummy
 
Constructor Summary
TableProperties()
          Constructs a TableProperties using ArcGIS Engine.
TableProperties(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
TableProperties theTableProperties = (TableProperties) obj;
 
Method Summary
 void activeViewChanged(IDocumentEventsActiveViewChangedEvent theEvent)
          Fired when the active view changes.
 void add(ITableProperty pTableProperty)
          Add a table property.
 void afterDraw(IActiveViewEventsAfterDrawEvent theEvent)
          Fired after the specified phase is drawn.
 void afterItemDraw(IActiveViewEventsAfterItemDrawEvent theEvent)
          Fired after an individual view item is drawn.
 void assign(IClone src)
          Assigns the properties of src to the receiver.
 boolean beforeCloseDocument(IDocumentEventsBeforeCloseDocumentEvent theEvent)
          Fired before a document is closed.
 void closeDocument(IDocumentEventsCloseDocumentEvent theEvent)
          Fired when a document is closed.
 void contentsChanged(IActiveViewEventsContentsChangedEvent theEvent)
          Fired when the contents of the view changes.
 void contentsCleared(IActiveViewEventsContentsClearedEvent theEvent)
          Fired when the contents of the view is cleared.
 boolean equals(java.lang.Object o)
          Compare this object with another
 IClone esri_clone()
          Clones the receiver and assigns the result to *clone.
 void focusMapChanged(IActiveViewEventsFocusMapChangedEvent theEvent)
          Fired when a new map is made active.
 Font getCellFont()
          Table font.
 IColor getCellTextColor()
          Text color use in table window.
 void getClassID(GUID[] pClassID)
          getClassID
static java.lang.String getClsid()
          getClsid.
 Font getHeadingFont()
          Table font.
 IColor getHeadingTextColor()
          Text color use in table window.
 IEnumTableProperties getIEnumTableProperties()
          Table Property Enum.
 java.lang.String getIndexFieldCharacter()
          Character placed to the right of the field name when a field is indexed.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 IColor getSelectionColor()
          Selection color use to highlight rows.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 int hashCode()
          the hashcode for this object
 boolean isAutoValidateEdits()
          Indicates if the table window should validate any changes to the data during editing.
 void isDirty()
          isDirty
 boolean isEqual(IClone other)
          Indicates if the receiver and other have the same properties.
 boolean isFireRowChangedEventsForJoins()
          Indicates if row changed events should be fires for join tables.
 boolean isIdentical(IClone other)
          Indicates if the receiver and other are the same object.
 boolean isShowCodedValueDomainDescriptions()
          Indicates if the table window shows coded value domain descriptions or values.
 boolean isShowIndexFieldCharacter()
          Indicates whether table window should show field index character.
 void itemAdded(IActiveViewEventsItemAddedEvent theEvent)
          Fired when an item is added to the view.
 void itemDeleted(IActiveViewEventsItemDeletedEvent theEvent)
          Fired when an item is deleted from the view.
 void itemReordered(IActiveViewEventsItemReorderedEvent theEvent)
          Fired when a view item is reordered.
 void load(IStream pstm)
          load
 void mapsChanged(IDocumentEventsMapsChangedEvent theEvent)
          Fired when a change is made to the map collection.
 void newDocument(IDocumentEventsNewDocumentEvent theEvent)
          Fired when a new document is created.
 ITableProperty next()
          Get the next table property.
 boolean onContextMenu(IDocumentEventsOnContextMenuEvent theEvent)
          Indicates if a context menu should be displayed at the given xy location.
 void openDocument(IDocumentEventsOpenDocumentEvent theEvent)
          Fired when a document is opened.
 void readExternal(java.io.ObjectInput in)
           
 void release()
          Release a TableProperties.
 void remove(ITableProperty pTableProperty)
          Remove a table property.
 void removeAll()
          Remove all table properties.
 void reset()
          Reset.
 void save(IStream pstm, int fClearDirty)
          save
 void selectionChanged(IActiveViewEventsSelectionChangedEvent theEvent)
          Call this function to fire the selection changed event.
 void setAutoValidateEdits(boolean autoValidateEdits)
          Indicates if the table window should validate any changes to the data during editing.
 void setCellFontByRef(Font ppFont)
          Table font.
 void setCellTextColorByRef(IColor ppTextColor)
          Text color use in table window.
 void setFireRowChangedEventsForJoins(boolean pFireRowEvents)
          Indicates if row changed events should be fires for join tables.
 void setHeadingFontByRef(Font ppFont)
          Table font.
 void setHeadingTextColorByRef(IColor ppTextColor)
          Text color use in table window.
 void setIndexFieldCharacter(java.lang.String pIndexChar)
          Character placed to the right of the field name when a field is indexed.
 void setSelectionColorByRef(IColor ppSelectionColor)
          Selection color use to highlight rows.
 void setShowCodedValueDomainDescriptions(boolean showCodedValueDomainDescriptions)
          Indicates if the table window shows coded value domain descriptions or values.
 void setShowIndexFieldCharacter(boolean pShowIndexCharacter)
          Indicates whether table window should show field index character.
 void spatialReferenceChanged(IActiveViewEventsSpatialReferenceChangedEvent theEvent)
          Fired when the spatial reference is changed.
 void viewRefreshed(IActiveViewEventsViewRefreshedEvent theEvent)
          Fired when view is refreshed before draw happens.
 void writeExternal(java.io.ObjectOutput out)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

serialVersionUID

public static final long serialVersionUID
See Also:
Constant Field Values
Constructor Detail

TableProperties

public TableProperties()
                throws java.io.IOException,
                       java.net.UnknownHostException
Constructs a TableProperties using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

TableProperties

public TableProperties(java.lang.Object obj)
                throws java.io.IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
TableProperties theTableProperties = (TableProperties) obj;

Construct a TableProperties using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to TableProperties.

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()
getClsid.


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 TableProperties.

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

getIEnumTableProperties

public IEnumTableProperties getIEnumTableProperties()
                                             throws java.io.IOException,
                                                    AutomationException
Table Property Enum.

Specified by:
getIEnumTableProperties in interface ITableProperties
Returns:
A reference to a com.esri.arcgis.arcmapui.IEnumTableProperties
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

add

public void add(ITableProperty pTableProperty)
         throws java.io.IOException,
                AutomationException
Add a table property.

Specified by:
add in interface ITableProperties
Parameters:
pTableProperty - A reference to a com.esri.arcgis.arcmapui.ITableProperty (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

remove

public void remove(ITableProperty pTableProperty)
            throws java.io.IOException,
                   AutomationException
Remove a table property.

Specified by:
remove in interface ITableProperties
Parameters:
pTableProperty - A reference to a com.esri.arcgis.arcmapui.ITableProperty (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeAll

public void removeAll()
               throws java.io.IOException,
                      AutomationException
Remove all table properties.

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

getSelectionColor

public IColor getSelectionColor()
                         throws java.io.IOException,
                                AutomationException
Selection color use to highlight rows.

Specified by:
getSelectionColor in interface IDefaultTableProperty
Returns:
A reference to a com.esri.arcgis.display.IColor
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSelectionColorByRef

public void setSelectionColorByRef(IColor ppSelectionColor)
                            throws java.io.IOException,
                                   AutomationException
Selection color use to highlight rows.

Specified by:
setSelectionColorByRef in interface IDefaultTableProperty
Parameters:
ppSelectionColor - A reference to a com.esri.arcgis.display.IColor (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHeadingFont

public Font getHeadingFont()
                    throws java.io.IOException,
                           AutomationException
Table font.

Specified by:
getHeadingFont in interface ITableCharacteristics
Returns:
A reference to a com.esri.arcgis.support.ms.stdole.Font (A com.esri.arcgis.support.ms.stdole.Font COM typedef)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCellFont

public Font getCellFont()
                 throws java.io.IOException,
                        AutomationException
Table font.

Specified by:
getCellFont in interface ITableCharacteristics
Returns:
A reference to a com.esri.arcgis.support.ms.stdole.Font (A com.esri.arcgis.support.ms.stdole.Font COM typedef)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHeadingTextColor

public IColor getHeadingTextColor()
                           throws java.io.IOException,
                                  AutomationException
Text color use in table window.

Specified by:
getHeadingTextColor in interface ITableCharacteristics
Returns:
A reference to a com.esri.arcgis.display.IColor
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCellTextColor

public IColor getCellTextColor()
                        throws java.io.IOException,
                               AutomationException
Text color use in table window.

Specified by:
getCellTextColor in interface ITableCharacteristics
Returns:
A reference to a com.esri.arcgis.display.IColor
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getIndexFieldCharacter

public java.lang.String getIndexFieldCharacter()
                                        throws java.io.IOException,
                                               AutomationException
Character placed to the right of the field name when a field is indexed.

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

isShowIndexFieldCharacter

public boolean isShowIndexFieldCharacter()
                                  throws java.io.IOException,
                                         AutomationException
Indicates whether table window should show field index character.

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

setHeadingFontByRef

public void setHeadingFontByRef(Font ppFont)
                         throws java.io.IOException,
                                AutomationException
Table font.

Specified by:
setHeadingFontByRef in interface ITableCharacteristics
Parameters:
ppFont - A reference to a com.esri.arcgis.support.ms.stdole.Font (A com.esri.arcgis.support.ms.stdole.Font COM typedef) (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCellFontByRef

public void setCellFontByRef(Font ppFont)
                      throws java.io.IOException,
                             AutomationException
Table font.

Specified by:
setCellFontByRef in interface ITableCharacteristics
Parameters:
ppFont - A reference to a com.esri.arcgis.support.ms.stdole.Font (A com.esri.arcgis.support.ms.stdole.Font COM typedef) (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setHeadingTextColorByRef

public void setHeadingTextColorByRef(IColor ppTextColor)
                              throws java.io.IOException,
                                     AutomationException
Text color use in table window.

Specified by:
setHeadingTextColorByRef in interface ITableCharacteristics
Parameters:
ppTextColor - A reference to a com.esri.arcgis.display.IColor (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCellTextColorByRef

public void setCellTextColorByRef(IColor ppTextColor)
                           throws java.io.IOException,
                                  AutomationException
Text color use in table window.

Specified by:
setCellTextColorByRef in interface ITableCharacteristics
Parameters:
ppTextColor - A reference to a com.esri.arcgis.display.IColor (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIndexFieldCharacter

public void setIndexFieldCharacter(java.lang.String pIndexChar)
                            throws java.io.IOException,
                                   AutomationException
Character placed to the right of the field name when a field is indexed.

Specified by:
setIndexFieldCharacter in interface ITableCharacteristics
Parameters:
pIndexChar - The pIndexChar (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setShowIndexFieldCharacter

public void setShowIndexFieldCharacter(boolean pShowIndexCharacter)
                                throws java.io.IOException,
                                       AutomationException
Indicates whether table window should show field index character.

Specified by:
setShowIndexFieldCharacter in interface ITableCharacteristics
Parameters:
pShowIndexCharacter - The pShowIndexCharacter (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isAutoValidateEdits

public boolean isAutoValidateEdits()
                            throws java.io.IOException,
                                   AutomationException
Indicates if the table window should validate any changes to the data during editing.

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

setAutoValidateEdits

public void setAutoValidateEdits(boolean autoValidateEdits)
                          throws java.io.IOException,
                                 AutomationException
Indicates if the table window should validate any changes to the data during editing.

Specified by:
setAutoValidateEdits in interface ITableCharacteristics
Parameters:
autoValidateEdits - The autoValidateEdits (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isShowCodedValueDomainDescriptions

public boolean isShowCodedValueDomainDescriptions()
                                           throws java.io.IOException,
                                                  AutomationException
Indicates if the table window shows coded value domain descriptions or values.

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

setShowCodedValueDomainDescriptions

public void setShowCodedValueDomainDescriptions(boolean showCodedValueDomainDescriptions)
                                         throws java.io.IOException,
                                                AutomationException
Indicates if the table window shows coded value domain descriptions or values.

Specified by:
setShowCodedValueDomainDescriptions in interface ITableCharacteristics
Parameters:
showCodedValueDomainDescriptions - The showCodedValueDomainDescriptions (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isFireRowChangedEventsForJoins

public boolean isFireRowChangedEventsForJoins()
                                       throws java.io.IOException,
                                              AutomationException
Indicates if row changed events should be fires for join tables.

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

setFireRowChangedEventsForJoins

public void setFireRowChangedEventsForJoins(boolean pFireRowEvents)
                                     throws java.io.IOException,
                                            AutomationException
Indicates if row changed events should be fires for join tables.

Specified by:
setFireRowChangedEventsForJoins in interface ITableCalculator
Parameters:
pFireRowEvents - The pFireRowEvents (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

next

public ITableProperty next()
                    throws java.io.IOException,
                           AutomationException
Get the next table property.

Specified by:
next in interface IEnumTableProperties
Returns:
A reference to a com.esri.arcgis.arcmapui.ITableProperty
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

reset

public void reset()
           throws java.io.IOException,
                  AutomationException
Reset.

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

esri_clone

public IClone esri_clone()
                  throws java.io.IOException,
                         AutomationException
Clones the receiver and assigns the result to *clone.

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

assign

public void assign(IClone src)
            throws java.io.IOException,
                   AutomationException
Assigns the properties of src to the receiver.

Specified by:
assign in interface IClone
Parameters:
src - A reference to a com.esri.arcgis.system.IClone (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws java.io.IOException,
                       AutomationException
Indicates if the receiver and other have the same properties.

Specified by:
isEqual in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The equal
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws java.io.IOException,
                           AutomationException
Indicates if the receiver and other are the same object.

Specified by:
isIdentical in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The identical
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException
getClassID

Specified by:
getClassID in interface IPersist
Parameters:
pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException
isDirty

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

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException
load

Specified by:
load in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException
save

Specified by:
save in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
fClearDirty - The fClearDirty (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException
getSizeMax

Specified by:
getSizeMax in interface IPersistStream
Parameters:
pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

activeViewChanged

public void activeViewChanged(IDocumentEventsActiveViewChangedEvent theEvent)
                       throws java.io.IOException,
                              AutomationException
Fired when the active view changes.

Specified by:
activeViewChanged in interface IDocumentEvents
Parameters:
theEvent - The event
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

mapsChanged

public void mapsChanged(IDocumentEventsMapsChangedEvent theEvent)
                 throws java.io.IOException,
                        AutomationException
Fired when a change is made to the map collection.

Specified by:
mapsChanged in interface IDocumentEvents
Parameters:
theEvent - The event
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

onContextMenu

public boolean onContextMenu(IDocumentEventsOnContextMenuEvent theEvent)
                      throws java.io.IOException,
                             AutomationException
Indicates if a context menu should be displayed at the given xy location. Return true if handled.

Specified by:
onContextMenu in interface IDocumentEvents
Parameters:
theEvent - The event
Returns:
The handled
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

newDocument

public void newDocument(IDocumentEventsNewDocumentEvent theEvent)
                 throws java.io.IOException,
                        AutomationException
Fired when a new document is created.

Specified by:
newDocument in interface IDocumentEvents
Parameters:
theEvent - The event
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

openDocument

public void openDocument(IDocumentEventsOpenDocumentEvent theEvent)
                  throws java.io.IOException,
                         AutomationException
Fired when a document is opened.

Specified by:
openDocument in interface IDocumentEvents
Parameters:
theEvent - The event
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

beforeCloseDocument

public boolean beforeCloseDocument(IDocumentEventsBeforeCloseDocumentEvent theEvent)
                            throws java.io.IOException,
                                   AutomationException
Fired before a document is closed. Return True to abort the close process.

Specified by:
beforeCloseDocument in interface IDocumentEvents
Parameters:
theEvent - The event
Returns:
The abortClose
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

closeDocument

public void closeDocument(IDocumentEventsCloseDocumentEvent theEvent)
                   throws java.io.IOException,
                          AutomationException
Fired when a document is closed.

Specified by:
closeDocument in interface IDocumentEvents
Parameters:
theEvent - The event
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

contentsChanged

public void contentsChanged(IActiveViewEventsContentsChangedEvent theEvent)
                     throws java.io.IOException,
                            AutomationException
Fired when the contents of the view changes.

Specified by:
contentsChanged in interface IActiveViewEvents
Parameters:
theEvent - The event
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

contentsCleared

public void contentsCleared(IActiveViewEventsContentsClearedEvent theEvent)
                     throws java.io.IOException,
                            AutomationException
Fired when the contents of the view is cleared.

Specified by:
contentsCleared in interface IActiveViewEvents
Parameters:
theEvent - The event
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

itemAdded

public void itemAdded(IActiveViewEventsItemAddedEvent theEvent)
               throws java.io.IOException,
                      AutomationException
Fired when an item is added to the view.

Specified by:
itemAdded in interface IActiveViewEvents
Parameters:
theEvent - The event
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

itemDeleted

public void itemDeleted(IActiveViewEventsItemDeletedEvent theEvent)
                 throws java.io.IOException,
                        AutomationException
Fired when an item is deleted from the view.

Specified by:
itemDeleted in interface IActiveViewEvents
Parameters:
theEvent - The event
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

itemReordered

public void itemReordered(IActiveViewEventsItemReorderedEvent theEvent)
                   throws java.io.IOException,
                          AutomationException
Fired when a view item is reordered.

Specified by:
itemReordered in interface IActiveViewEvents
Parameters:
theEvent - The event
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

selectionChanged

public void selectionChanged(IActiveViewEventsSelectionChangedEvent theEvent)
                      throws java.io.IOException,
                             AutomationException
Call this function to fire the selection changed event.

Specified by:
selectionChanged in interface IActiveViewEvents
Parameters:
theEvent - The event
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

viewRefreshed

public void viewRefreshed(IActiveViewEventsViewRefreshedEvent theEvent)
                   throws java.io.IOException,
                          AutomationException
Fired when view is refreshed before draw happens.

Specified by:
viewRefreshed in interface IActiveViewEvents
Parameters:
theEvent - The event
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

afterDraw

public void afterDraw(IActiveViewEventsAfterDrawEvent theEvent)
               throws java.io.IOException,
                      AutomationException
Fired after the specified phase is drawn.

Specified by:
afterDraw in interface IActiveViewEvents
Parameters:
theEvent - The event
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

afterItemDraw

public void afterItemDraw(IActiveViewEventsAfterItemDrawEvent theEvent)
                   throws java.io.IOException,
                          AutomationException
Fired after an individual view item is drawn. Example: view items include layers in a map or elements in a page layout.

Specified by:
afterItemDraw in interface IActiveViewEvents
Parameters:
theEvent - The event
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

focusMapChanged

public void focusMapChanged(IActiveViewEventsFocusMapChangedEvent theEvent)
                     throws java.io.IOException,
                            AutomationException
Fired when a new map is made active.

Specified by:
focusMapChanged in interface IActiveViewEvents
Parameters:
theEvent - The event
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

spatialReferenceChanged

public void spatialReferenceChanged(IActiveViewEventsSpatialReferenceChangedEvent theEvent)
                             throws java.io.IOException,
                                    AutomationException
Fired when the spatial reference is changed.

Specified by:
spatialReferenceChanged in interface IActiveViewEvents
Parameters:
theEvent - The event
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException
Specified by:
writeExternal in interface java.io.Externalizable
Throws:
java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
Specified by:
readExternal in interface java.io.Externalizable
Throws:
java.io.IOException
java.lang.ClassNotFoundException