com.esri.arcgis.catalogUI
Class DescriptionWindow

java.lang.Object
  com.esri.arcgis.catalogUI.DescriptionWindow

All Implemented Interfaces:

IDescriptionWindow, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class DescriptionWindow
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IDescriptionWindow

Provides access to memebers of DescriptionWindow.

Product Availability

Available with ArcGIS Desktop.

See Also:

Serialized Form

Constructor Summary

DescriptionWindow()
Constructs a DescriptionWindow using ArcGIS Engine.

DescriptionWindow(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
DescriptionWindow theDescriptionWindow = (DescriptionWindow) obj;

Method Summary

boolean	equals(Object o) Compare this object with another
IDescriptionWindow	findViaItemInfo(com.esri.arcgis.search.IItemInfo pItemInfo) Indicates whether the Item Description Window is already being displayed for the selected ItemInfo.
IDescriptionWindow	findViaObject(IGxObject pGxObject) Indicates whether the Item Description Window is already being displayed for the selected GxObject.
IDescriptionWindow	findViaPath(String path) Indicates whether the Item Description Window is already being displayed for the selected path.
static String	getClsid() getClsid.
IGxDocumentationView	getDocumentationView() The documentation view in item description window.
int	getHWnd() HWND of the Item Description Window.
com.esri.arcgis.search.IItemInfo	getTargetItemInfo() Pass the target ItemInfo to item description window.
IGxObject	getTargetObject() Pass the editing target object to item description window.
String	getTargetPath() Pass the editing target path to item description window.
int	hashCode() the hashcode for this object
void	refresh() Refresh the Item Description Window.
void	setApplicationByRef(IApplication rhs1) Provides the window with a reference to the application.
void	setTargetItemInfoByRef(com.esri.arcgis.search.IItemInfo ppItemInfo) Pass the target ItemInfo to item description window.
void	setTargetObjectByRef(IGxObject ppGxObject) Pass the editing target object to item description window.
void	setTargetPath(String path) Pass the editing target path to item description window.
void	show(boolean rePosition) Show tem Description Window of select object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

DescriptionWindow

public DescriptionWindow()
                  throws IOException,
                         UnknownHostException

Constructs a DescriptionWindow using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

DescriptionWindow

public DescriptionWindow(Object obj)
                  throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
DescriptionWindow theDescriptionWindow = (DescriptionWindow) obj;

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

setApplicationByRef

public void setApplicationByRef(IApplication rhs1)
                         throws IOException,
                                AutomationException

Provides the window with a reference to the application.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setApplicationByRef in interface IDescriptionWindow

Parameters:

rhs1 - A reference to a com.esri.arcgis.framework.IApplication (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTargetObjectByRef

public void setTargetObjectByRef(IGxObject ppGxObject)
                          throws IOException,
                                 AutomationException

Pass the editing target object to item description window.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setTargetObjectByRef in interface IDescriptionWindow

Parameters:

ppGxObject - A reference to a com.esri.arcgis.catalog.IGxObject (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTargetObject

public IGxObject getTargetObject()
                          throws IOException,
                                 AutomationException

Pass the editing target object to item description window.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getTargetObject in interface IDescriptionWindow

Returns:

A reference to a com.esri.arcgis.catalog.IGxObject

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTargetPath

public void setTargetPath(String path)
                   throws IOException,
                          AutomationException

Pass the editing target path to item description window.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setTargetPath in interface IDescriptionWindow

Parameters:

path - The path (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTargetPath

public String getTargetPath()
                     throws IOException,
                            AutomationException

Pass the editing target path to item description window.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getTargetPath in interface IDescriptionWindow

Returns:

The path

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTargetItemInfoByRef

public void setTargetItemInfoByRef(com.esri.arcgis.search.IItemInfo ppItemInfo)
                            throws IOException,
                                   AutomationException

Pass the target ItemInfo to item description window.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setTargetItemInfoByRef in interface IDescriptionWindow

Parameters:

ppItemInfo - A reference to a com.esri.arcgis.search.IItemInfo (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTargetItemInfo

public com.esri.arcgis.search.IItemInfo getTargetItemInfo()
                                                   throws IOException,
                                                          AutomationException

Pass the target ItemInfo to item description window.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getTargetItemInfo in interface IDescriptionWindow

Returns:

A reference to a com.esri.arcgis.search.IItemInfo

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findViaItemInfo

public IDescriptionWindow findViaItemInfo(com.esri.arcgis.search.IItemInfo pItemInfo)
                                   throws IOException,
                                          AutomationException

Indicates whether the Item Description Window is already being displayed for the selected ItemInfo.

Product Availability

Available with ArcGIS Desktop.

Specified by:

findViaItemInfo in interface IDescriptionWindow

Parameters:

pItemInfo - A reference to a com.esri.arcgis.search.IItemInfo (in)

Returns:

A reference to a com.esri.arcgis.catalogUI.IDescriptionWindow

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findViaPath

public IDescriptionWindow findViaPath(String path)
                               throws IOException,
                                      AutomationException

Indicates whether the Item Description Window is already being displayed for the selected path.

Product Availability

Available with ArcGIS Desktop.

Specified by:

findViaPath in interface IDescriptionWindow

Parameters:

path - The path (in)

Returns:

A reference to a com.esri.arcgis.catalogUI.IDescriptionWindow

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findViaObject

public IDescriptionWindow findViaObject(IGxObject pGxObject)
                                 throws IOException,
                                        AutomationException

Indicates whether the Item Description Window is already being displayed for the selected GxObject.

Product Availability

Available with ArcGIS Desktop.

Specified by:

findViaObject in interface IDescriptionWindow

Parameters:

pGxObject - A reference to a com.esri.arcgis.catalog.IGxObject (in)

Returns:

A reference to a com.esri.arcgis.catalogUI.IDescriptionWindow

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHWnd

public int getHWnd()
            throws IOException,
                   AutomationException

HWND of the Item Description Window.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getHWnd in interface IDescriptionWindow

Returns:

The hWnd (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

show

public void show(boolean rePosition)
          throws IOException,
                 AutomationException

Show tem Description Window of select object.

Product Availability

Available with ArcGIS Desktop.

Specified by:

show in interface IDescriptionWindow

Parameters:

rePosition - The rePosition (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

refresh

public void refresh()
             throws IOException,
                    AutomationException

Refresh the Item Description Window.

Product Availability

Available with ArcGIS Desktop.

Specified by:

refresh in interface IDescriptionWindow

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDocumentationView

public IGxDocumentationView getDocumentationView()
                                          throws IOException,
                                                 AutomationException

The documentation view in item description window.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getDocumentationView in interface IDescriptionWindow

Returns:

A reference to a com.esri.arcgis.catalogUI.IGxDocumentationView

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.