com.esri.arcgis.arcmapui
Class MetadataViewWindow

java.lang.Object
  com.esri.arcgis.arcmapui.MetadataViewWindow

All Implemented Interfaces:

IDocumentEvents, IMetadataViewWindow, IMetadataViewWindow2, IMetadataViewWindow3, IActiveViewEvents, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable, java.util.EventListener

public class MetadataViewWindow
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IMetadataViewWindow, IMetadataViewWindow2, IMetadataViewWindow3, IActiveViewEvents, IDocumentEvents

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

Description 'MetadataViewWindow class used to display the metadata of selected layer's data source.' 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.arcmapui.IMetadataViewWindow3

IID, IID83dac7ba_9f42_465a_8530_be77710e8f0b, xxDummy

Fields inherited from interface com.esri.arcgis.arcmapui.IMetadataViewWindow2

IIDcc40a88d_28c9_46fc_88cf_f487e81ead99

Fields inherited from interface com.esri.arcgis.arcmapui.IMetadataViewWindow

IID3d477e2f_b719_4ff0_9c48_8c4a01ef1f00

Fields inherited from interface com.esri.arcgis.carto.IActiveViewEvents

IID, IIDe79c5940_52dd_11d0_98be_00805f7ced21, xxDummy

Fields inherited from interface com.esri.arcgis.arcmapui.IDocumentEvents

IID, IID6db7c4bd_0a7c_11d1_86aa_0000f8751720, xxDummy

Constructor Summary

MetadataViewWindow()
Constructs a MetadataViewWindow using ArcGIS Engine.

MetadataViewWindow(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
MetadataViewWindow theMetadataViewWindow = (MetadataViewWindow) 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.
boolean	equals(java.lang.Object o) Compare this object with another
IMetadataViewWindow	findViaLayer(ILayer pLayer) Is Metadata (of a layer's data source) already being displayed.
IMetadataViewWindow	findViaStandaloneTable(IStandaloneTable pStandaloneTable) Is Metadata (of a standalone table) already being displayed.
void	focusMapChanged(IActiveViewEventsFocusMapChangedEvent theEvent) Fired when a new map is made active.
static java.lang.String	getClsid() getClsid.
int	getHWnd() HWND of the Metadata View Window.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
ILayer	getLayer() The stored layer.
IPropertySet	getMetadata() The Metadata of the selected layer's data source.
IMetadataHelper	getMetadataHelper() The Metadata helper to get stylesheet path and metadata.
java.lang.String	getSelectedStylesheet() Selected Stylesheet from Metadata helper.
IStandaloneTable	getStandaloneTable() The standalone table to view/edit.
java.lang.String	getStylesheetPath() Stylesheet path from Metadata helper.
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	openDocument(IDocumentEventsOpenDocumentEvent theEvent) Fired when a document is opened.
void	refresh() Refresh the metadata view.
void	release() Release a MetadataViewWindow.
void	selectionChanged(IActiveViewEventsSelectionChangedEvent theEvent) Call this function to fire the selection changed event.
void	setAGSServerObjectNameByRef(IAGSServerObjectName rhs1) Pass the server object name to Metadata View window.
void	setApplicationByRef(java.lang.Object rhs1) Provides the window with a reference to the application.
void	setDataSourceByRef(IDatasetName rhs1) Pass the data source name of the selected layer to Metadata View window.
void	setLayerByRef(ILayer pLayer) The stored layer.
void	setMetadataByRef(IPropertySet rhs1) Pass the metadata directly to Metadata View window.
void	setStandaloneTableByRef(IStandaloneTable table) The standalone table to view/edit.
void	show(boolean show) Show MetadataViewWindow of the selected layer's data source.
void	spatialReferenceChanged(IActiveViewEventsSpatialReferenceChangedEvent theEvent) Fired when the spatial reference is changed.
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

MetadataViewWindow

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

Constructs a MetadataViewWindow using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

MetadataViewWindow

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

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

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

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

Specified by:

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

setApplicationByRef

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

Provides the window with a reference to the application.

Specified by:

setApplicationByRef in interface IMetadataViewWindow

Parameters:

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

getLayer

public ILayer getLayer()
                throws java.io.IOException,
                       AutomationException

The stored layer.

Specified by:

getLayer in interface IMetadataViewWindow

Returns:

A reference to a com.esri.arcgis.carto.ILayer

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLayerByRef

public void setLayerByRef(ILayer pLayer)
                   throws java.io.IOException,
                          AutomationException

The stored layer.

Specified by:

setLayerByRef in interface IMetadataViewWindow

Parameters:

pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setStandaloneTableByRef

public void setStandaloneTableByRef(IStandaloneTable table)
                             throws java.io.IOException,
                                    AutomationException

The standalone table to view/edit.

Specified by:

setStandaloneTableByRef in interface IMetadataViewWindow

Parameters:

table - A reference to a com.esri.arcgis.carto.IStandaloneTable (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStandaloneTable

public IStandaloneTable getStandaloneTable()
                                    throws java.io.IOException,
                                           AutomationException

The standalone table to view/edit.

Specified by:

getStandaloneTable in interface IMetadataViewWindow

Returns:

A reference to a com.esri.arcgis.carto.IStandaloneTable

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDataSourceByRef

public void setDataSourceByRef(IDatasetName rhs1)
                        throws java.io.IOException,
                               AutomationException

Pass the data source name of the selected layer to Metadata View window.

Specified by:

setDataSourceByRef in interface IMetadataViewWindow

Parameters:

rhs1 - A reference to a com.esri.arcgis.geodatabase.IDatasetName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

findViaLayer

public IMetadataViewWindow findViaLayer(ILayer pLayer)
                                 throws java.io.IOException,
                                        AutomationException

Is Metadata (of a layer's data source) already being displayed.

Specified by:

findViaLayer in interface IMetadataViewWindow

Parameters:

pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

Returns:

A reference to a com.esri.arcgis.arcmapui.IMetadataViewWindow

Throws:

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

AutomationException - If the ArcObject component throws an exception.

findViaStandaloneTable

public IMetadataViewWindow findViaStandaloneTable(IStandaloneTable pStandaloneTable)
                                           throws java.io.IOException,
                                                  AutomationException

Is Metadata (of a standalone table) already being displayed.

Specified by:

findViaStandaloneTable in interface IMetadataViewWindow

Parameters:

pStandaloneTable - A reference to a com.esri.arcgis.carto.IStandaloneTable (in)

Returns:

A reference to a com.esri.arcgis.arcmapui.IMetadataViewWindow

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 Metadata View Window.

Specified by:

getHWnd in interface IMetadataViewWindow

Returns:

The hWnd (A COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStylesheetPath

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

Stylesheet path from Metadata helper.

Specified by:

getStylesheetPath in interface IMetadataViewWindow

Returns:

The pStylesheetPath

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSelectedStylesheet

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

Selected Stylesheet from Metadata helper.

Specified by:

getSelectedStylesheet in interface IMetadataViewWindow

Returns:

The pSelectedStylesheet

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMetadata

public IPropertySet getMetadata()
                         throws java.io.IOException,
                                AutomationException

The Metadata of the selected layer's data source.

Specified by:

getMetadata in interface IMetadataViewWindow

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMetadataHelper

public IMetadataHelper getMetadataHelper()
                                  throws java.io.IOException,
                                         AutomationException

The Metadata helper to get stylesheet path and metadata.

Specified by:

getMetadataHelper in interface IMetadataViewWindow

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

show

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

Show MetadataViewWindow of the selected layer's data source.

Specified by:

show in interface IMetadataViewWindow

Parameters:

show - The show (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 metadata view.

Specified by:

refresh in interface IMetadataViewWindow

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMetadataByRef

public void setMetadataByRef(IPropertySet rhs1)
                      throws java.io.IOException,
                             AutomationException

Pass the metadata directly to Metadata View window.

Specified by:

setMetadataByRef in interface IMetadataViewWindow2

Parameters:

rhs1 - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAGSServerObjectNameByRef

public void setAGSServerObjectNameByRef(IAGSServerObjectName rhs1)
                                 throws java.io.IOException,
                                        AutomationException

Pass the server object name to Metadata View window.

Specified by:

setAGSServerObjectNameByRef in interface IMetadataViewWindow3

Parameters:

rhs1 - A reference to a com.esri.arcgis.gisclient.IAGSServerObjectName (in)

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.

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.