com.esri.arcgis.catalogUI
Class GxPreview

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

All Implemented Interfaces:

IGxSelectionEvents, IGxPreview, IGxView, IGxViewContainer, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable, java.util.EventListener

public class GxPreview
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IGxView, IGxPreview, IGxSelectionEvents, IGxViewContainer

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

Description 'GxView that represents the preview.' 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.IGxView

IID, IIDb1de27ab_d892_11d1_aa81_064342000000, xxDummy

Fields inherited from interface com.esri.arcgis.catalogUI.IGxPreview

IID, IIDda1862ec_95f8_11d2_af67_080009ec734b, xxDummy

Fields inherited from interface com.esri.arcgis.catalog.IGxSelectionEvents

IID, IIDbdbbb3f9_d0b2_11d1_aed9_080009ec734b, xxDummy

Fields inherited from interface com.esri.arcgis.catalogUI.IGxViewContainer

IID, IIDe7e3da73_f904_11d3_a68c_0008c7d3ae8d, xxDummy

Constructor Summary

GxPreview()
Constructs a GxPreview using ArcGIS Engine.

GxPreview(java.lang.Object obj)
Construct a GxPreview using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

void	activate(IGxApplication application, IGxCatalog catalog) Activates the view.
boolean	applies(IGxObject selection) Indicates if the view can display the given object.
void	deactivate() Deactivates the view.
boolean	equals(java.lang.Object o) Compare this object with another
IGxView	findView(IUID pUID, boolean bRecursive) Finds a view by CLSID.
IUID	getClassID() The class ID of the view.
static java.lang.String	getClsid() getClsid.
IUID	getDefaultToolbarCLSID() The class ID of the view's default toolbar.
int	getHWnd() The view's window handle.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.String	getName() The name of the view.
ISet	getSupportedViewClassIDs() A list of the class IDs for the views that are supported given the current selection.
IGxView	getView() The current view.
IUID	getViewClassID() The class ID of the current view.
IEnumGxView	getViews() All Gxviews in the application.
int	hashCode() the hashcode for this object
boolean	isSupportsTools() Indicates if the view supports tools.
void	onSelectionChanged(IGxSelectionEventsOnSelectionChangedEvent theEvent) Called when the selection contents have changed.
void	refresh() Refreshes the view.
void	release() Release a GxPreview.
void	setViewClassID(IUID viewClassID) The class ID of the current view.
void	systemSettingChanged(int flag, java.lang.String section) Informs the view that a system setting has changed.

Methods inherited from class java.lang.Object

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

Constructor Detail

GxPreview

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

Constructs a GxPreview using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

GxPreview

public GxPreview(java.lang.Object obj)
          throws java.io.IOException

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems GxPreview theGxPreview = (GxPreview) 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 GxPreview.

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

Specified by:

getName in interface IGxView

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClassID

public IUID getClassID()
                throws java.io.IOException,
                       AutomationException

The class ID of the view.

Specified by:

getClassID in interface IGxView

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.

getHWnd

public int getHWnd()
            throws java.io.IOException,
                   AutomationException

The view's window handle.

Specified by:

getHWnd in interface IGxView

Returns:

The window (A COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefaultToolbarCLSID

public IUID getDefaultToolbarCLSID()
                            throws java.io.IOException,
                                   AutomationException

The class ID of the view's default toolbar. Not currently used.

Specified by:

getDefaultToolbarCLSID in interface IGxView

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.

isSupportsTools

public boolean isSupportsTools()
                        throws java.io.IOException,
                               AutomationException

Indicates if the view supports tools.

Specified by:

isSupportsTools in interface IGxView

Returns:

The supportsTools

Throws:

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

AutomationException - If the ArcObject component throws an exception.

applies

public boolean applies(IGxObject selection)
                throws java.io.IOException,
                       AutomationException

Indicates if the view can display the given object.

Specified by:

applies in interface IGxView

Parameters:

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

Returns:

The applies

Throws:

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

AutomationException - If the ArcObject component throws an exception.

activate

public void activate(IGxApplication application,
                     IGxCatalog catalog)
              throws java.io.IOException,
                     AutomationException

Activates the view.

Specified by:

activate in interface IGxView

Parameters:

application - A reference to a com.esri.arcgis.catalogUI.IGxApplication (in)

catalog - A reference to a com.esri.arcgis.catalog.IGxCatalog (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 view.

Specified by:

deactivate in interface IGxView

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

Refreshes the view.

Specified by:

refresh in interface IGxView

Throws:

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

AutomationException - If the ArcObject component throws an exception.

systemSettingChanged

public void systemSettingChanged(int flag,
                                 java.lang.String section)
                          throws java.io.IOException,
                                 AutomationException

Informs the view that a system setting has changed.

Specified by:

systemSettingChanged in interface IGxView

Parameters:

flag - The flag (in)

section - The section (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getView

public IGxView getView()
                throws java.io.IOException,
                       AutomationException

The current view.

Specified by:

getView in interface IGxPreview

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getViewClassID

public IUID getViewClassID()
                    throws java.io.IOException,
                           AutomationException

The class ID of the current view.

Specified by:

getViewClassID in interface IGxPreview

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.

setViewClassID

public void setViewClassID(IUID viewClassID)
                    throws java.io.IOException,
                           AutomationException

The class ID of the current view.

Specified by:

setViewClassID in interface IGxPreview

Parameters:

viewClassID - A reference to a com.esri.arcgis.system.IUID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSupportedViewClassIDs

public ISet getSupportedViewClassIDs()
                              throws java.io.IOException,
                                     AutomationException

A list of the class IDs for the views that are supported given the current selection.

Specified by:

getSupportedViewClassIDs in interface IGxPreview

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.

onSelectionChanged

public void onSelectionChanged(IGxSelectionEventsOnSelectionChangedEvent theEvent)
                        throws java.io.IOException,
                               AutomationException

Called when the selection contents have changed.

Specified by:

onSelectionChanged in interface IGxSelectionEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

findView

public IGxView findView(IUID pUID,
                        boolean bRecursive)
                 throws java.io.IOException,
                        AutomationException

Finds a view by CLSID. If recursive is true, it will return views in a container view.

Specified by:

findView in interface IGxViewContainer

Parameters:

pUID - A reference to a com.esri.arcgis.system.IUID (in)

bRecursive - The bRecursive (in, optional, pass false if not required)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getViews

public IEnumGxView getViews()
                     throws java.io.IOException,
                            AutomationException

All Gxviews in the application.

Specified by:

getViews in interface IGxViewContainer

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.