com.esri.arcgis.catalogUI
Class DescriptionWindow

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

All Implemented Interfaces:

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

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

COM Class 'DescriptionWindow'. Generated 3/19/2015 1:20:49 PM from 'C:\ArcGIS\COM\esriCatalogUI.olb'

Description 'Provides access to memebers of DescriptionWindow.' 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.catalogUI.IDescriptionWindow

IID, IID65f86c2e_40e4_4135_8ebc_364a0ef7e9ae, xxDummy

Constructor Summary

DescriptionWindow()
Constructs a DescriptionWindow using ArcGIS Engine.

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

Method Summary

boolean	equals(java.lang.Object o) Compare this object with another
IDescriptionWindow	findViaItemInfo(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(java.lang.String path) Indicates whether the Item Description Window is already being displayed for the selected path.
static java.lang.String	getClsid() getClsid.
IGxDocumentationView	getDocumentationView() The documentation view in item description window.
int	getHWnd() HWND of the Item Description Window.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
IItemInfo	getTargetItemInfo() Pass the target ItemInfo to item description window.
IGxObject	getTargetObject() Pass the editing target object to item description window.
java.lang.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	release() Release a DescriptionWindow.
void	setApplicationByRef(IApplication rhs1) Provides the window with a reference to the application.
void	setTargetItemInfoByRef(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(java.lang.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

Constructor Detail

DescriptionWindow

public DescriptionWindow()
                  throws java.io.IOException,
                         java.net.UnknownHostException

Constructs a DescriptionWindow using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

DescriptionWindow

public DescriptionWindow(java.lang.Object obj)
                  throws java.io.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:

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

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

setApplicationByRef

public void setApplicationByRef(IApplication rhs1)
                         throws java.io.IOException,
                                AutomationException

Provides the window with a reference to the application.

Specified by:

setApplicationByRef in interface IDescriptionWindow

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTargetObjectByRef

public void setTargetObjectByRef(IGxObject ppGxObject)
                          throws java.io.IOException,
                                 AutomationException

Pass the editing target object to item description window.

Specified by:

setTargetObjectByRef in interface IDescriptionWindow

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTargetObject

public IGxObject getTargetObject()
                          throws java.io.IOException,
                                 AutomationException

Pass the editing target object to item description window.

Specified by:

getTargetObject in interface IDescriptionWindow

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTargetPath

public void setTargetPath(java.lang.String path)
                   throws java.io.IOException,
                          AutomationException

Pass the editing target path to item description window.

Specified by:

setTargetPath in interface IDescriptionWindow

Parameters:

path - The path (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTargetPath

public java.lang.String getTargetPath()
                               throws java.io.IOException,
                                      AutomationException

Pass the editing target path to item description window.

Specified by:

getTargetPath in interface IDescriptionWindow

Returns:

The path

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTargetItemInfoByRef

public void setTargetItemInfoByRef(IItemInfo ppItemInfo)
                            throws java.io.IOException,
                                   AutomationException

Pass the target ItemInfo to item description window.

Specified by:

setTargetItemInfoByRef in interface IDescriptionWindow

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTargetItemInfo

public IItemInfo getTargetItemInfo()
                            throws java.io.IOException,
                                   AutomationException

Pass the target ItemInfo to item description window.

Specified by:

getTargetItemInfo in interface IDescriptionWindow

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findViaItemInfo

public IDescriptionWindow findViaItemInfo(IItemInfo pItemInfo)
                                   throws java.io.IOException,
                                          AutomationException

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

Specified by:

findViaItemInfo in interface IDescriptionWindow

Parameters:

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

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findViaPath

public IDescriptionWindow findViaPath(java.lang.String path)
                               throws java.io.IOException,
                                      AutomationException

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

Specified by:

findViaPath in interface IDescriptionWindow

Parameters:

path - The path (in)

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findViaObject

public IDescriptionWindow findViaObject(IGxObject pGxObject)
                                 throws java.io.IOException,
                                        AutomationException

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

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:

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

HWND of the Item Description Window.

Specified by:

getHWnd in interface IDescriptionWindow

Returns:

The hWnd (A COM typedef)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

show

public void show(boolean rePosition)
          throws java.io.IOException,
                 AutomationException

Show tem Description Window of select object.

Specified by:

show in interface IDescriptionWindow

Parameters:

rePosition - The rePosition (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

refresh

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

Refresh the Item Description Window.

Specified by:

refresh in interface IDescriptionWindow

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDocumentationView

public IGxDocumentationView getDocumentationView()
                                          throws java.io.IOException,
                                                 AutomationException

The documentation view in item description window.

Specified by:

getDocumentationView in interface IDescriptionWindow

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.