com.esri.arcgis.arcmapui
Class RasterToolsDockWin

java.lang.Object
  extended by com.esri.arcgis.arcmapui.RasterToolsDockWin
All Implemented Interfaces:
IDocumentEvents, IRasterDockWin, IActiveViewEvents, IConnectionPointContainer, IDockableWindowDef, IDockableWindowImageDef, IDockableWindowInitialPlacement, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable, java.util.EventListener

public class RasterToolsDockWin
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IDockableWindowDef, IDockableWindowInitialPlacement, IDockableWindowImageDef, IDocumentEvents, IActiveViewEvents, IConnectionPointContainer, IRasterDockWin

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

Description 'The Raster Tools Dockable Window.' 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.framework.IDockableWindowDef
IID, IID3d1fa10a_f154_11d3_a67e_0008c7df97b9, xxDummy
 
Fields inherited from interface com.esri.arcgis.framework.IDockableWindowInitialPlacement
IID, IID1ec80980_7a02_426d_bd2b_c6d3beb2ed54, xxDummy
 
Fields inherited from interface com.esri.arcgis.framework.IDockableWindowImageDef
IID, IID08f4fc5d_c23f_4210_b289_1350ed5632ed, xxDummy
 
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
 
Fields inherited from interface com.esri.arcgis.display.IConnectionPointContainer
IID, IIDb196b284_bab4_101a_b69c_00aa00341d07, xxDummy
 
Fields inherited from interface com.esri.arcgis.arcmapui.IRasterDockWin
IID, IID743cbf92_694d_41ea_8ff8_e245431f3ac3, xxDummy
 
Constructor Summary
RasterToolsDockWin()
          Constructs a RasterToolsDockWin using ArcGIS Engine.
RasterToolsDockWin(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RasterToolsDockWin theRasterToolsDockWin = (RasterToolsDockWin) obj;
 
Method Summary
 void activeViewChanged(IDocumentEventsActiveViewChangedEvent theEvent)
          Fired when the active view changes.
 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 enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
          enumConnectionPoints
 boolean equals(java.lang.Object o)
          Compare this object with another
 void findConnectionPoint(GUID riid, IConnectionPoint[] ppCP)
          findConnectionPoint
 void focusMapChanged(IActiveViewEventsFocusMapChangedEvent theEvent)
          Fired when a new map is made active.
 int getBitmap()
          Provide a bitmap for dockviews
 java.lang.String getCaption()
          The caption of the dockable window.
 int getChildHWND()
          The hWnd of the window to be embedded in a dockable window.
static java.lang.String getClsid()
          getClsid.
 int getDockPosition()
          DockPosition
 int getHeight()
          Height
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 java.lang.String getName()
          The name of the dockable window.
 IUID getNeighbor()
          Neighbor
 java.lang.Object getUserData()
          User defined data.
 int getWidth()
          Width
 int hashCode()
          the hashcode for this object
 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.
 boolean onContextMenu(IDocumentEventsOnContextMenuEvent theEvent)
          Indicates if a context menu should be displayed at the given xy location.
 void onCreate(java.lang.Object hook)
          Occurs when this dockable window is created and provides access to the application.
 void onDestroy()
          Occurs when the docking window is about to be destroyed.
 void openDocument(IDocumentEventsOpenDocumentEvent theEvent)
          Fired when a document is opened.
 void release()
          Release a RasterToolsDockWin.
 void selectionChanged(IActiveViewEventsSelectionChangedEvent theEvent)
          Call this function to fire the selection changed event.
 void spatialReferenceChanged(IActiveViewEventsSpatialReferenceChangedEvent theEvent)
          Fired when the spatial reference is changed.
 void update()
          Updates child windows
 void updateResult(java.lang.String measure)
          Updates child windows
 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

RasterToolsDockWin

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

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

RasterToolsDockWin

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

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

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

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

onCreate

public void onCreate(java.lang.Object hook)
              throws java.io.IOException,
                     AutomationException
Occurs when this dockable window is created and provides access to the application.

Specified by:
onCreate in interface IDockableWindowDef
Parameters:
hook - A reference to another Automation Object (IDispatch) (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getChildHWND

public int getChildHWND()
                 throws java.io.IOException,
                        AutomationException
The hWnd of the window to be embedded in a dockable window.

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

getName

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

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

getCaption

public java.lang.String getCaption()
                            throws java.io.IOException,
                                   AutomationException
The caption of the dockable window.

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

onDestroy

public void onDestroy()
               throws java.io.IOException,
                      AutomationException
Occurs when the docking window is about to be destroyed.

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

getUserData

public java.lang.Object getUserData()
                             throws java.io.IOException,
                                    AutomationException
User defined data.

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

getHeight

public int getHeight()
              throws java.io.IOException,
                     AutomationException
Height

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

getWidth

public int getWidth()
             throws java.io.IOException,
                    AutomationException
Width

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

getDockPosition

public int getDockPosition()
                    throws java.io.IOException,
                           AutomationException
DockPosition

Specified by:
getDockPosition in interface IDockableWindowInitialPlacement
Returns:
A com.esri.arcgis.framework.esriDockFlags constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNeighbor

public IUID getNeighbor()
                 throws java.io.IOException,
                        AutomationException
Neighbor

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

getBitmap

public int getBitmap()
              throws java.io.IOException,
                     AutomationException
Provide a bitmap for dockviews

Specified by:
getBitmap in interface IDockableWindowImageDef
Returns:
The bitmap (A COM typedef)
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.

enumConnectionPoints

public void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
                          throws java.io.IOException,
                                 AutomationException
enumConnectionPoints

Specified by:
enumConnectionPoints in interface IConnectionPointContainer
Parameters:
ppEnum - A reference to a com.esri.arcgis.display.IEnumConnectionPoints (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findConnectionPoint

public void findConnectionPoint(GUID riid,
                                IConnectionPoint[] ppCP)
                         throws java.io.IOException,
                                AutomationException
findConnectionPoint

Specified by:
findConnectionPoint in interface IConnectionPointContainer
Parameters:
riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
ppCP - A reference to a com.esri.arcgis.display.IConnectionPoint (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

update

public void update()
            throws java.io.IOException,
                   AutomationException
Updates child windows

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

updateResult

public void updateResult(java.lang.String measure)
                  throws java.io.IOException,
                         AutomationException
Updates child windows

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