com.esri.arcgis.arcscene
Class ISxDocumentProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.arcscene.ISxDocumentProxy

All Implemented Interfaces:

ISxDocument, java.io.Externalizable, java.io.Serializable

public class ISxDocumentProxy
extends com.esri.arcgis.interop.Dispatch
implements ISxDocument, java.io.Serializable

Internal use class Proxy for COM Interface 'ISxDocument'. Generated 3/19/2015 1:21:02 PM from 'C:\ArcGIS\COM\esriArcScene.olb'

Description: 'Provides access to members that control the ArcScene Document object.' 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

boolean	noncastable
static java.lang.Class	targetClass

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Fields inherited from interface com.esri.arcgis.arcscene.ISxDocument

IID, IIDc80aa9de_a836_11d3_abb8_0008c73fca1c

Constructor Summary

	ISxDocumentProxy() For internal use only
	ISxDocumentProxy(java.lang.Object obj)
protected	ISxDocumentProxy(java.lang.Object obj, java.lang.String iid)
	ISxDocumentProxy(java.lang.String CLSID, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
protected	ISxDocumentProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)

Method Summary

void	addLayer(ILayer layer) Adds a layer to the current focus map.
void	addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource)
ISxContentsView	getContentsView(int index) The contents view at the specified index.
int	getContentsViewCount() The number of contents views in the document.
java.lang.Object	getContextItem() The item that is selected or was last right-clicked.
ISxContentsView	getCurrentContentsView() The current contents view of the document.
IColor	getDefaultColor(int type) The default color for the given type.
IScene	getScene() The scene.
int	getSearchTolerancePixels() The global search tolerance in pixels for selection.
java.lang.Object	getSelectedItem() The selected item in the layer control.
ILayer	getSelectedLayer() The selected layer in the layer control.
boolean	isRelativePaths() Indicates if path names are stored relative to the document.
boolean	isSavePreview() Indicates if a preview image is saved in the document.
void	removeAllLayers() Removes all layers.
void	removeListener(java.lang.String iidStr, java.lang.Object theListener)
void	setContextItem(java.lang.Object item) The item that is selected or was last right-clicked.
void	setCurrentContentsViewByRef(ISxContentsView view) The current contents view of the document.
void	setDefaultColor(int type, IColor color) The default color for the given type.
void	setDelayUpdateContents(boolean rhs1) Indicates whether to ignore document update notifications.
void	setRelativePaths(boolean relPaths) Indicates if path names are stored relative to the document.
void	setSavePreview(boolean savePreview) Indicates if a preview image is saved in the document.
void	setScene(IScene pScene) The scene.
void	setSearchTolerancePixels(int tol) The global search tolerance in pixels for selection.
void	updateContents() Notifies the document that the contents have been updated.

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

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

Field Detail

targetClass

public static final java.lang.Class targetClass

noncastable

public boolean noncastable

Constructor Detail

ISxDocumentProxy

public ISxDocumentProxy(java.lang.String CLSID,
                        java.lang.String host,
                        com.esri.arcgis.interop.AuthInfo authInfo)
                 throws java.net.UnknownHostException,
                        java.io.IOException

Throws:

java.net.UnknownHostException

java.io.IOException

ISxDocumentProxy

public ISxDocumentProxy()

For internal use only

ISxDocumentProxy

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

Throws:

java.io.IOException

ISxDocumentProxy

protected ISxDocumentProxy(java.lang.Object obj,
                           java.lang.String iid)
                    throws java.io.IOException

Throws:

java.io.IOException

ISxDocumentProxy

protected ISxDocumentProxy(java.lang.String CLSID,
                           java.lang.String iid,
                           java.lang.String host,
                           com.esri.arcgis.interop.AuthInfo authInfo)
                    throws java.io.IOException

Throws:

java.io.IOException

Method Detail

addListener

public void addListener(java.lang.String iidStr,
                        java.lang.Object theListener,
                        java.lang.Object theSource)
                 throws java.io.IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

java.io.IOException

removeListener

public void removeListener(java.lang.String iidStr,
                           java.lang.Object theListener)
                    throws java.io.IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

java.io.IOException

getSelectedLayer

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

The selected layer in the layer control.

Specified by:

getSelectedLayer in interface ISxDocument

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.

getSelectedItem

public java.lang.Object getSelectedItem()
                                 throws java.io.IOException,
                                        AutomationException

The selected item in the layer control.

Specified by:

getSelectedItem in interface ISxDocument

Returns:

A reference to another Object (IUnknown)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getContextItem

public java.lang.Object getContextItem()
                                throws java.io.IOException,
                                       AutomationException

The item that is selected or was last right-clicked.

Specified by:

getContextItem in interface ISxDocument

Returns:

A reference to another Object (IUnknown)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setContextItem

public void setContextItem(java.lang.Object item)
                    throws java.io.IOException,
                           AutomationException

The item that is selected or was last right-clicked.

Specified by:

setContextItem in interface ISxDocument

Parameters:

item - A reference to another Object (IUnknown) (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addLayer

public void addLayer(ILayer layer)
              throws java.io.IOException,
                     AutomationException

Adds a layer to the current focus map.

Specified by:

addLayer in interface ISxDocument

Parameters:

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

removeAllLayers

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

Removes all layers.

Specified by:

removeAllLayers in interface ISxDocument

Throws:

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

AutomationException - If the ArcObject component throws an exception.

updateContents

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

Notifies the document that the contents have been updated.

Specified by:

updateContents in interface ISxDocument

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDelayUpdateContents

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

Indicates whether to ignore document update notifications.

Specified by:

setDelayUpdateContents in interface ISxDocument

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSearchTolerancePixels

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

The global search tolerance in pixels for selection.

Specified by:

getSearchTolerancePixels in interface ISxDocument

Returns:

The tol

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSearchTolerancePixels

public void setSearchTolerancePixels(int tol)
                              throws java.io.IOException,
                                     AutomationException

The global search tolerance in pixels for selection.

Specified by:

setSearchTolerancePixels in interface ISxDocument

Parameters:

tol - The tol (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefaultColor

public IColor getDefaultColor(int type)
                       throws java.io.IOException,
                              AutomationException

The default color for the given type.

Specified by:

getDefaultColor in interface ISxDocument

Parameters:

type - A com.esri.arcgis.arcmapui.esriMxDefaultColorTypes constant (in)

Returns:

A reference to a com.esri.arcgis.display.IColor

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDefaultColor

public void setDefaultColor(int type,
                            IColor color)
                     throws java.io.IOException,
                            AutomationException

The default color for the given type.

Specified by:

setDefaultColor in interface ISxDocument

Parameters:

type - A com.esri.arcgis.arcmapui.esriMxDefaultColorTypes constant (in)

color - A reference to a com.esri.arcgis.display.IColor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getScene

public IScene getScene()
                throws java.io.IOException,
                       AutomationException

The scene.

Specified by:

getScene in interface ISxDocument

Returns:

A reference to a com.esri.arcgis.analyst3d.IScene

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setScene

public void setScene(IScene pScene)
              throws java.io.IOException,
                     AutomationException

The scene.

Specified by:

setScene in interface ISxDocument

Parameters:

pScene - A reference to a com.esri.arcgis.analyst3d.IScene (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isRelativePaths

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

Indicates if path names are stored relative to the document.

Specified by:

isRelativePaths in interface ISxDocument

Returns:

The relPaths

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRelativePaths

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

Indicates if path names are stored relative to the document.

Specified by:

setRelativePaths in interface ISxDocument

Parameters:

relPaths - The relPaths (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSavePreview

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

Indicates if a preview image is saved in the document.

Specified by:

isSavePreview in interface ISxDocument

Returns:

The savePreview

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSavePreview

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

Indicates if a preview image is saved in the document.

Specified by:

setSavePreview in interface ISxDocument

Parameters:

savePreview - The savePreview (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCurrentContentsView

public ISxContentsView getCurrentContentsView()
                                       throws java.io.IOException,
                                              AutomationException

The current contents view of the document.

Specified by:

getCurrentContentsView in interface ISxDocument

Returns:

A reference to a com.esri.arcgis.arcscene.ISxContentsView

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCurrentContentsViewByRef

public void setCurrentContentsViewByRef(ISxContentsView view)
                                 throws java.io.IOException,
                                        AutomationException

The current contents view of the document.

Specified by:

setCurrentContentsViewByRef in interface ISxDocument

Parameters:

view - A reference to a com.esri.arcgis.arcscene.ISxContentsView (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getContentsViewCount

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

The number of contents views in the document.

Specified by:

getContentsViewCount in interface ISxDocument

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getContentsView

public ISxContentsView getContentsView(int index)
                                throws java.io.IOException,
                                       AutomationException

The contents view at the specified index.

Specified by:

getContentsView in interface ISxDocument

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.arcscene.ISxContentsView

Throws:

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

AutomationException - If the ArcObject component throws an exception.