com.esri.arcgis.arcmapui
Class TOCCatalogView

java.lang.Object
  extended by com.esri.arcgis.arcmapui.TOCCatalogView
All Implemented Interfaces:
IContentsView, IContentsViewSelection, IDocumentEvents, IActiveViewEvents, com.esri.arcgis.interop.RemoteObjRef, IPersist, IComPropertySheetEvents, java.io.Serializable, java.util.EventListener

public class TOCCatalogView
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IContentsView, IComPropertySheetEvents, IActiveViewEvents, IDocumentEvents, IPersist, IContentsViewSelection

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

Description 'Esri TOC Catalog View.' 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.arcmapui.IContentsView
IID, IIDfddb19ef_cb6f_11d2_9f38_00c04f6bc78e, xxDummy
 
Fields inherited from interface com.esri.arcgis.systemUI.IComPropertySheetEvents
IID, IID6b7b57f8_5765_11d0_92d9_00805f7c28b0, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IActiveViewEvents
IID, IIDe79c5940_52dd_11d0_98be_00805f7ced21, xxDummy
 
Fields inherited from interface com.esri.arcgis.arcmapui.IDocumentEvents
IID, IID6db7c4bd_0a7c_11d1_86aa_0000f8751720, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IPersist
IID, IID0000010c_0000_0000_c000_000000000046, xxDummy
 
Fields inherited from interface com.esri.arcgis.arcmapui.IContentsViewSelection
IID, IID30be80a5_6158_4b49_9077_61024ce6f746, xxDummy
 
Constructor Summary
TOCCatalogView()
          Constructs a TOCCatalogView using ArcGIS Engine.
TOCCatalogView(java.lang.Object obj)
          Construct a TOCCatalogView using a reference to such an object returned from ArcGIS Engine or Server.
 
Method Summary
 void activate(int parentHWnd, IMxDocument document)
          Activates the contents view.
 void activeViewChanged(IDocumentEventsActiveViewChangedEvent theEvent)
          Fired when the active view changes.
 void addToSelectedItems(java.lang.Object item)
          Adds to the selected items.
 void afterDraw(IActiveViewEventsAfterDrawEvent theEvent)
          Fired after the specified phase is drawn.
 void afterItemDraw(IActiveViewEventsAfterItemDrawEvent theEvent)
          Fired after an individual view item is drawn.
 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.
 void deactivate()
          Deactivates the contents view.
 boolean equals(java.lang.Object o)
          Compare this object with another
 void focusMapChanged(IActiveViewEventsFocusMapChangedEvent theEvent)
          Fired when a new map is made active.
 void getClassID(GUID[] pClassID)
          getClassID
static java.lang.String getClsid()
          getClsid.
 java.lang.Object getContextItem()
          The context item (could be an enumerator).
 int getHWnd()
          The HWND of the contents view.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 java.lang.String getName()
          The name of the contents view.
 java.lang.Object getSelectedItem()
          The selected item (could be an enumerator).
 ISet getSelectedItems()
          Selection set containing the highlighted items in contents view.
 int hashCode()
          the hashcode for this object
 boolean isShowLines()
          Indicates if lines are shown in the TOC tree.
 boolean isVisible()
          Indicates if the view is visible.
 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 mapsChanged(IDocumentEventsMapsChangedEvent theEvent)
          Fired when a change is made to the map collection.
 void newDocument(IDocumentEventsNewDocumentEvent theEvent)
          Fired when a new document is created.
 void onApply(IComPropertySheetEventsOnApplyEvent theEvent)
          Occurs when changes are applied.
 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 refresh(java.lang.Object item)
          Refreshes the contents view.
 void release()
          Release a TOCCatalogView.
 void removeFromSelectedItems(java.lang.Object item)
          Removes an item from the selected items.
 void selectionChanged(IActiveViewEventsSelectionChangedEvent theEvent)
          Call this function to fire the selection changed event.
 void setContextItem(java.lang.Object item)
          The context item (could be an enumerator).
 void setProcessEvents(boolean rhs1)
          Indicates if the view is currently responding to events.
 void setSelectedItem(java.lang.Object item)
          The selected item (could be an enumerator).
 void setSelectedItems(ISet selection)
          Selection set containing the highlighted items in contents view.
 void setShowLines(boolean show)
          Indicates if lines are shown in the TOC tree.
 void setVisible(boolean vis)
          Indicates if the view is visible.
 void spatialReferenceChanged(IActiveViewEventsSpatialReferenceChangedEvent theEvent)
          Fired when the spatial reference is changed.
 void viewRefreshed(IActiveViewEventsViewRefreshedEvent theEvent)
          Fired when view is refreshed before draw happens.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TOCCatalogView

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

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

TOCCatalogView

public TOCCatalogView(java.lang.Object obj)
               throws java.io.IOException
Construct a TOCCatalogView using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to TOCCatalogView.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
java.io.IOException - if there are interop problems TOCCatalogView theTOCCatalogView = (TOCCatalogView) obj;
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 TOCCatalogView.

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

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException
The name of the contents view.

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

getHWnd

public int getHWnd()
            throws java.io.IOException,
                   AutomationException
The HWND of the contents view.

Specified by:
getHWnd in interface IContentsView
Returns:
The hWnd (A COM typedef)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

activate

public void activate(int parentHWnd,
                     IMxDocument document)
              throws java.io.IOException,
                     AutomationException
Activates the contents view.

Specified by:
activate in interface IContentsView
Parameters:
parentHWnd - The parentHWnd (A COM typedef) (in)
document - A reference to a com.esri.arcgis.arcmapui.IMxDocument (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deactivate

public void deactivate()
                throws java.io.IOException,
                       AutomationException
Deactivates the contents view.

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

refresh

public void refresh(java.lang.Object item)
             throws java.io.IOException,
                    AutomationException
Refreshes the contents view. If a non-null item is specified, it refreshes only that item and its children.

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

getSelectedItem

public java.lang.Object getSelectedItem()
                                 throws java.io.IOException,
                                        AutomationException
The selected item (could be an enumerator).

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

setSelectedItem

public void setSelectedItem(java.lang.Object item)
                     throws java.io.IOException,
                            AutomationException
The selected item (could be an enumerator).

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

addToSelectedItems

public void addToSelectedItems(java.lang.Object item)
                        throws java.io.IOException,
                               AutomationException
Adds to the selected items.

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

removeFromSelectedItems

public void removeFromSelectedItems(java.lang.Object item)
                             throws java.io.IOException,
                                    AutomationException
Removes an item from the selected items.

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

getContextItem

public java.lang.Object getContextItem()
                                throws java.io.IOException,
                                       AutomationException
The context item (could be an enumerator).

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

setContextItem

public void setContextItem(java.lang.Object item)
                    throws java.io.IOException,
                           AutomationException
The context item (could be an enumerator).

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

isShowLines

public boolean isShowLines()
                    throws java.io.IOException,
                           AutomationException
Indicates if lines are shown in the TOC tree.

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

setShowLines

public void setShowLines(boolean show)
                  throws java.io.IOException,
                         AutomationException
Indicates if lines are shown in the TOC tree.

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

isVisible

public boolean isVisible()
                  throws java.io.IOException,
                         AutomationException
Indicates if the view is visible.

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

setVisible

public void setVisible(boolean vis)
                throws java.io.IOException,
                       AutomationException
Indicates if the view is visible.

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

setProcessEvents

public void setProcessEvents(boolean rhs1)
                      throws java.io.IOException,
                             AutomationException
Indicates if the view is currently responding to events.

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

onApply

public void onApply(IComPropertySheetEventsOnApplyEvent theEvent)
             throws java.io.IOException,
                    AutomationException
Occurs when changes are applied.

Specified by:
onApply in interface IComPropertySheetEvents
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.

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.

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.

getSelectedItems

public ISet getSelectedItems()
                      throws java.io.IOException,
                             AutomationException
Selection set containing the highlighted items in contents view.

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

setSelectedItems

public void setSelectedItems(ISet selection)
                      throws java.io.IOException,
                             AutomationException
Selection set containing the highlighted items in contents view.

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