com.esri.arcgis.catalogUI
Class GxDocumentationView

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

All Implemented Interfaces:

IGxCatalogEvents, IGxSelectionEvents, IGxDocumentationView, IGxView, IGxViewPrint, com.esri.arcgis.interop.RemoteObjRef, Serializable, EventListener

public class GxDocumentationView
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGxView, IGxDocumentationView, IGxCatalogEvents, IGxSelectionEvents, IGxViewPrint

GxView that represents the metadata view.

Remarks

The metadata view in ArcCatalog is represented by GxDocumentationView. Since it is a GxView, it naturally supports IGxView. However, to manipulate it, you will want to work with IGxDocumentationView. This interface allows you to do three things: edit the metadata using a custom editor through Edit, edit the metadata properties with a default editor via EditProperties, and force the metadata to be updated with respect to the object's current attributes, through Synchronize. To build a custom editor, you will need to create an object that implements IMetadataEditor, and inform the metadata extension object to use it, through its IMetadataHelper::Editor property.

GxDocumentationView also implements IGxViewPrint, to enable you to print the nice formatted metadata.

The GxDocumentationView CoClass requires the Microsoft .NET Framework 3.0 or higher and the Windows Presentation Foundation (WPF) Toolkit to be installed. The WPFToolkit.dll must be referenced.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

See Also:

Serialized Form

Constructor Summary

GxDocumentationView()
Constructs a GxDocumentationView using ArcGIS Engine.

GxDocumentationView(Object obj)
Construct a GxDocumentationView 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.
void	edit() Opens the current metadata editor.
void	editProperties() Opens the Metadata Properties dialog box.
boolean	equals(Object o) Compare this object with another
IUID	getClassID() The class ID of the view.
static String	getClsid() getClsid.
IUID	getDefaultToolbarCLSID() The class ID of the view's default toolbar.
int	getHWnd() The view's window handle.
String	getName() The name of the view.
int	hashCode() the hashcode for this object
boolean	isPrintable() Indicates if the view can be printed.
boolean	isSupportsTools() Indicates if the view supports tools.
void	onObjectAdded(IGxCatalogEventsOnObjectAddedEvent theEvent) Called when an object has been added to some part of the catalog.
void	onObjectChanged(IGxCatalogEventsOnObjectChangedEvent theEvent) Called when an object in some part of the catalog has been changed.
void	onObjectDeleted(IGxCatalogEventsOnObjectDeletedEvent theEvent) Called when an object has been deleted from some part of the catalog.
void	onObjectRefreshed(IGxCatalogEventsOnObjectRefreshedEvent theEvent) Called when an object in some part of the catalog has been refreshed.
void	onRefreshAll(IGxCatalogEventsOnRefreshAllEvent theEvent) Called when the whole catalog has changed.
void	onSelectionChanged(IGxSelectionEventsOnSelectionChangedEvent theEvent) Called when the selection contents have changed.
void	print() Prints the view.
void	refresh() Refreshes the view.
void	synchronize() Writes the current property values to the metadata.
void	systemSettingChanged(int flag, 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

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

getJintegraDispatch, release

Constructor Detail

GxDocumentationView

public GxDocumentationView()
                    throws IOException,
                           UnknownHostException

Constructs a GxDocumentationView using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

GxDocumentationView

public GxDocumentationView(Object obj)
                    throws IOException

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems GxDocumentationView theGxDocumentationView = (GxDocumentationView) obj;

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

getName

public String getName()
               throws IOException,
                      AutomationException

The name of the view.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getName in interface IGxView

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public IUID getClassID()
                throws IOException,
                       AutomationException

The class ID of the view.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getClassID in interface IGxView

Returns:

A reference to a com.esri.arcgis.system.IUID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHWnd

public int getHWnd()
            throws IOException,
                   AutomationException

The view's window handle.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getHWnd in interface IGxView

Returns:

The window (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultToolbarCLSID

public IUID getDefaultToolbarCLSID()
                            throws IOException,
                                   AutomationException

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

Remarks

DefaultToolbarCLSID provides a reference to the default toolbar for the particular view. The default toolbar for a view would contain tools that were appropriate for the current type of GxView.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getDefaultToolbarCLSID in interface IGxView

Returns:

A reference to a com.esri.arcgis.system.IUID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportsTools

public boolean isSupportsTools()
                        throws IOException,
                               AutomationException

Indicates if the view supports tools.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

isSupportsTools in interface IGxView

Returns:

The supportsTools

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

applies

public boolean applies(IGxObject selection)
                throws IOException,
                       AutomationException

Indicates if the view can display the given object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

applies in interface IGxView

Parameters:

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

Returns:

The applies

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

activate

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

Activates the view.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deactivate

public void deactivate()
                throws IOException,
                       AutomationException

Deactivates the view.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

deactivate in interface IGxView

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

refresh

public void refresh()
             throws IOException,
                    AutomationException

Refreshes the view.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

refresh in interface IGxView

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

systemSettingChanged

public void systemSettingChanged(int flag,
                                 String section)
                          throws IOException,
                                 AutomationException

Informs the view that a system setting has changed.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

systemSettingChanged in interface IGxView

Parameters:

flag - The flag (in)

section - The section (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

edit

public void edit()
          throws IOException,
                 AutomationException

Opens the current metadata editor.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

edit in interface IGxDocumentationView

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

editProperties

public void editProperties()
                    throws IOException,
                           AutomationException

Opens the Metadata Properties dialog box.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

editProperties in interface IGxDocumentationView

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

synchronize

public void synchronize()
                 throws IOException,
                        AutomationException

Writes the current property values to the metadata.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

synchronize in interface IGxDocumentationView

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onRefreshAll

public void onRefreshAll(IGxCatalogEventsOnRefreshAllEvent theEvent)
                  throws IOException,
                         AutomationException

Called when the whole catalog has changed.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

onRefreshAll in interface IGxCatalogEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onObjectAdded

public void onObjectAdded(IGxCatalogEventsOnObjectAddedEvent theEvent)
                   throws IOException,
                          AutomationException

Called when an object has been added to some part of the catalog.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

onObjectAdded in interface IGxCatalogEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onObjectDeleted

public void onObjectDeleted(IGxCatalogEventsOnObjectDeletedEvent theEvent)
                     throws IOException,
                            AutomationException

Called when an object has been deleted from some part of the catalog.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

onObjectDeleted in interface IGxCatalogEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onObjectChanged

public void onObjectChanged(IGxCatalogEventsOnObjectChangedEvent theEvent)
                     throws IOException,
                            AutomationException

Called when an object in some part of the catalog has been changed.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

onObjectChanged in interface IGxCatalogEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onObjectRefreshed

public void onObjectRefreshed(IGxCatalogEventsOnObjectRefreshedEvent theEvent)
                       throws IOException,
                              AutomationException

Called when an object in some part of the catalog has been refreshed.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

onObjectRefreshed in interface IGxCatalogEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onSelectionChanged

public void onSelectionChanged(IGxSelectionEventsOnSelectionChangedEvent theEvent)
                        throws IOException,
                               AutomationException

Called when the selection contents have changed.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

onSelectionChanged in interface IGxSelectionEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isPrintable

public boolean isPrintable()
                    throws IOException,
                           AutomationException

Indicates if the view can be printed.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

isPrintable in interface IGxViewPrint

Returns:

The isPrintable

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

print

public void print()
           throws IOException,
                  AutomationException

Prints the view.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

print in interface IGxViewPrint

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.