com.esri.arcgis.controls
Class ISceneControlProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.controls.ISceneControlProxy

All Implemented Interfaces:

ISceneControl, java.io.Externalizable, java.io.Serializable

public class ISceneControlProxy
extends com.esri.arcgis.interop.Dispatch
implements ISceneControl, java.io.Serializable

Internal use class Proxy for COM Interface 'ISceneControl'. Generated 3/19/2015 1:21:01 PM from 'C:\ArcGIS\COM\esriControls.olb'

Description: 'Provides access to members that control the SceneControl.' 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.controls.ISceneControl

DISPID__501_GET_NAME, DISPID__501_PUT_NAME, DISPID__504_GET_NAME, DISPID__504_PUT_NAME, DISPID__514_GET_NAME, DISPID__514_PUT_NAME, DISPID__515_GET_NAME, DISPID__520_GET_NAME, DISPID__520_PUT_NAME, DISPID__521_GET_NAME, DISPID__521_PUT_NAME, DISPID__522_GET_NAME, DISPID__522_PUTREF_NAME, DISPID__552_NAME, DISPID_1_NAME, DISPID_10_GET_NAME, DISPID_10_PUT_NAME, DISPID_11_GET_NAME, DISPID_12_GET_NAME, DISPID_12_PUT_NAME, DISPID_13_GET_NAME, DISPID_13_PUT_NAME, DISPID_14_GET_NAME, DISPID_14_PUT_NAME, DISPID_15_GET_NAME, DISPID_15_PUT_NAME, DISPID_16_GET_NAME, DISPID_16_PUT_NAME, DISPID_2_GET_NAME, DISPID_3_GET_NAME, DISPID_3_PUTREF_NAME, DISPID_4_GET_NAME, DISPID_5_GET_NAME, DISPID_5_PUTREF_NAME, DISPID_6_GET_NAME, DISPID_6_PUTREF_NAME, DISPID_7_GET_NAME, DISPID_7_PUT_NAME, DISPID_8_NAME, DISPID_9_GET_NAME, DISPID_9_PUT_NAME, IID, IID886f5a43_99a7_477d_affb_8b374f30da45

Constructor Summary

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

Method Summary

void	aboutBox() Displays a dialog of information about the SceneControl.
void	addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource)
boolean	checkSxFile(java.lang.String fileName) Checks if a filename is a scene document.
boolean	esri_isEnabled() Indicates whether the SceneControl can respond to user generated events.
void	esri_setEnabled(boolean pbool) Indicates whether the SceneControl can respond to user generated events.
int	getAppearance() The appearance of the SceneControl.
int	getBackColor() Background color of the SceneControl.
int	getBorderStyle() The border style of the SceneControl.
ICamera	getCamera() The Camera object associated with the SceneControl.
ITool	getCurrentTool() Current active tool for the SceneControl.
java.lang.Object	getCustomProperty() A property to associate data with a control.
java.lang.String	getDocumentFilename() The filename of the last scene document loaded into the control.
int	getHWnd() Handle to the window associated with the SceneControl.
int	getKeyIntercept() A property that specifies interception of key strokes that are normally handled by the container.
Picture	getMouseIcon() Custom mouse icon used if MousePointer is 99.
int	getMousePointer() The mouse pointer displayed over the SceneControl.
java.lang.Object	getObject() A property that returns the underlying control.
IScene	getScene() The Scene object associated with the SceneControl.
ISceneGraph	getSceneGraph() The SceneGraph object associated with the SceneControl.
ISceneViewer	getSceneViewer() The SceneViewer associated with the SceneControl.
int	getTipDelay() The delay before scene tips are shown.
int	getTipStyle() The style of scene tips.
boolean	isNavigate() Indicates if the SceneControl performs default scene navigation in response to mouse events.
boolean	isOverrideBackColor() Indicates whether to override the background color of the scene document.
boolean	isShowSceneTips() Indicates if scene tips are shown.
void	loadSxFile(java.lang.String sxPath) Loads a scene document into the SceneControl.
void	removeListener(java.lang.String iidStr, java.lang.Object theListener)
void	setAppearance(int pappearance) The appearance of the SceneControl.
void	setBackColor(int pclr) Background color of the SceneControl.
void	setBorderStyle(int pstyle) The border style of the SceneControl.
void	setCameraByRef(ICamera pVal) The Camera object associated with the SceneControl.
void	setCurrentToolByRef(ITool pVal) Current active tool for the SceneControl.
void	setCustomProperty(java.lang.Object pVal) A property to associate data with a control.
void	setDocumentFilename(java.lang.String documentFilename) The filename of the last scene document loaded into the control.
void	setKeyIntercept(int pVal) A property that specifies interception of key strokes that are normally handled by the container.
void	setMouseIconByRef(Picture ppMouseIcon) Custom mouse icon used if MousePointer is 99.
void	setMousePointer(int ppointer) The mouse pointer displayed over the SceneControl.
void	setNavigate(boolean pVal) Indicates if the SceneControl performs default scene navigation in response to mouse events.
void	setOverrideBackColor(boolean pVal) Indicates whether to override the background color of the scene document.
void	setSceneGraphByRef(ISceneGraph pVal) The SceneGraph object associated with the SceneControl.
void	setShowSceneTips(boolean show) Indicates if scene tips are shown.
void	setTipDelay(int delay) The delay before scene tips are shown.
void	setTipStyle(int style) The style of scene tips.

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

ISceneControlProxy

public ISceneControlProxy(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

ISceneControlProxy

public ISceneControlProxy()

For internal use only

ISceneControlProxy

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

Throws:

java.io.IOException

ISceneControlProxy

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

Throws:

java.io.IOException

ISceneControlProxy

protected ISceneControlProxy(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

setBackColor

public void setBackColor(int pclr)
                  throws java.io.IOException,
                         AutomationException

Background color of the SceneControl.

Specified by:

setBackColor in interface ISceneControl

Parameters:

pclr - The pclr (A COM typedef) (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBackColor

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

Background color of the SceneControl.

Specified by:

getBackColor in interface ISceneControl

Returns:

The pclr (A COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBorderStyle

public void setBorderStyle(int pstyle)
                    throws java.io.IOException,
                           AutomationException

The border style of the SceneControl.

Specified by:

setBorderStyle in interface ISceneControl

Parameters:

pstyle - A com.esri.arcgis.controls.esriControlsBorderStyle constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBorderStyle

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

The border style of the SceneControl.

Specified by:

getBorderStyle in interface ISceneControl

Returns:

A com.esri.arcgis.controls.esriControlsBorderStyle constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

esri_setEnabled

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

Indicates whether the SceneControl can respond to user generated events.

Specified by:

esri_setEnabled in interface ISceneControl

Parameters:

pbool - The pbool (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

esri_isEnabled

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

Indicates whether the SceneControl can respond to user generated events.

Specified by:

esri_isEnabled in interface ISceneControl

Returns:

The pbool

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAppearance

public void setAppearance(int pappearance)
                   throws java.io.IOException,
                          AutomationException

The appearance of the SceneControl.

Specified by:

setAppearance in interface ISceneControl

Parameters:

pappearance - A com.esri.arcgis.controls.esriControlsAppearance constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAppearance

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

The appearance of the SceneControl.

Specified by:

getAppearance in interface ISceneControl

Returns:

A com.esri.arcgis.controls.esriControlsAppearance constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMousePointer

public void setMousePointer(int ppointer)
                     throws java.io.IOException,
                            AutomationException

The mouse pointer displayed over the SceneControl.

Specified by:

setMousePointer in interface ISceneControl

Parameters:

ppointer - A com.esri.arcgis.controls.esriControlsMousePointer constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMousePointer

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

The mouse pointer displayed over the SceneControl.

Specified by:

getMousePointer in interface ISceneControl

Returns:

A com.esri.arcgis.controls.esriControlsMousePointer constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMouseIconByRef

public void setMouseIconByRef(Picture ppMouseIcon)
                       throws java.io.IOException,
                              AutomationException

Custom mouse icon used if MousePointer is 99.

Specified by:

setMouseIconByRef in interface ISceneControl

Parameters:

ppMouseIcon - A reference to a com.esri.arcgis.support.ms.stdole.Picture (A com.esri.arcgis.support.ms.stdole.Picture COM typedef) (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMouseIcon

public Picture getMouseIcon()
                     throws java.io.IOException,
                            AutomationException

Custom mouse icon used if MousePointer is 99.

Specified by:

getMouseIcon in interface ISceneControl

Returns:

A reference to a com.esri.arcgis.support.ms.stdole.Picture (A com.esri.arcgis.support.ms.stdole.Picture COM typedef)

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

Handle to the window associated with the SceneControl.

Specified by:

getHWnd in interface ISceneControl

Returns:

The hWnd

Throws:

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

AutomationException - If the ArcObject component throws an exception.

aboutBox

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

Displays a dialog of information about the SceneControl.

Specified by:

aboutBox in interface ISceneControl

Throws:

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

AutomationException - If the ArcObject component throws an exception.

loadSxFile

public void loadSxFile(java.lang.String sxPath)
                throws java.io.IOException,
                       AutomationException

Loads a scene document into the SceneControl.

Specified by:

loadSxFile in interface ISceneControl

Parameters:

sxPath - The sxPath (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 object associated with the SceneControl.

Specified by:

getScene in interface ISceneControl

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.

getSceneGraph

public ISceneGraph getSceneGraph()
                          throws java.io.IOException,
                                 AutomationException

The SceneGraph object associated with the SceneControl.

Specified by:

getSceneGraph in interface ISceneControl

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSceneGraphByRef

public void setSceneGraphByRef(ISceneGraph pVal)
                        throws java.io.IOException,
                               AutomationException

The SceneGraph object associated with the SceneControl.

Specified by:

setSceneGraphByRef in interface ISceneControl

Parameters:

pVal - A reference to a com.esri.arcgis.analyst3d.ISceneGraph (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSceneViewer

public ISceneViewer getSceneViewer()
                            throws java.io.IOException,
                                   AutomationException

The SceneViewer associated with the SceneControl.

Specified by:

getSceneViewer in interface ISceneControl

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCamera

public ICamera getCamera()
                  throws java.io.IOException,
                         AutomationException

The Camera object associated with the SceneControl.

Specified by:

getCamera in interface ISceneControl

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCameraByRef

public void setCameraByRef(ICamera pVal)
                    throws java.io.IOException,
                           AutomationException

The Camera object associated with the SceneControl.

Specified by:

setCameraByRef in interface ISceneControl

Parameters:

pVal - A reference to a com.esri.arcgis.analyst3d.ICamera (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCurrentTool

public ITool getCurrentTool()
                     throws java.io.IOException,
                            AutomationException

Current active tool for the SceneControl. Set to nothing to clear the tool.

Specified by:

getCurrentTool in interface ISceneControl

Returns:

A reference to a com.esri.arcgis.systemUI.ITool

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCurrentToolByRef

public void setCurrentToolByRef(ITool pVal)
                         throws java.io.IOException,
                                AutomationException

Current active tool for the SceneControl. Set to nothing to clear the tool.

Specified by:

setCurrentToolByRef in interface ISceneControl

Parameters:

pVal - A reference to a com.esri.arcgis.systemUI.ITool (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isNavigate

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

Indicates if the SceneControl performs default scene navigation in response to mouse events.

Specified by:

isNavigate in interface ISceneControl

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setNavigate

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

Indicates if the SceneControl performs default scene navigation in response to mouse events.

Specified by:

setNavigate in interface ISceneControl

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

checkSxFile

public boolean checkSxFile(java.lang.String fileName)
                    throws java.io.IOException,
                           AutomationException

Checks if a filename is a scene document.

Specified by:

checkSxFile in interface ISceneControl

Parameters:

fileName - The fileName (in)

Returns:

The result

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCustomProperty

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

A property to associate data with a control.

Specified by:

getCustomProperty in interface ISceneControl

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCustomProperty

public void setCustomProperty(java.lang.Object pVal)
                       throws java.io.IOException,
                              AutomationException

A property to associate data with a control.

Specified by:

setCustomProperty in interface ISceneControl

Parameters:

pVal - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDocumentFilename

public void setDocumentFilename(java.lang.String documentFilename)
                         throws java.io.IOException,
                                AutomationException

The filename of the last scene document loaded into the control.

Specified by:

setDocumentFilename in interface ISceneControl

Parameters:

documentFilename - The documentFilename (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDocumentFilename

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

The filename of the last scene document loaded into the control.

Specified by:

getDocumentFilename in interface ISceneControl

Returns:

The documentFilename

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getObject

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

A property that returns the underlying control. This can be used when the control is inside a wrapper object that has been added by a development environment.

Specified by:

getObject in interface ISceneControl

Returns:

A reference to another Automation Object (IDispatch)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setOverrideBackColor

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

Indicates whether to override the background color of the scene document.

Specified by:

setOverrideBackColor in interface ISceneControl

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isOverrideBackColor

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

Indicates whether to override the background color of the scene document.

Specified by:

isOverrideBackColor in interface ISceneControl

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setShowSceneTips

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

Indicates if scene tips are shown.

Specified by:

setShowSceneTips in interface ISceneControl

Parameters:

show - The show (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isShowSceneTips

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

Indicates if scene tips are shown.

Specified by:

isShowSceneTips in interface ISceneControl

Returns:

The show

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTipStyle

public void setTipStyle(int style)
                 throws java.io.IOException,
                        AutomationException

The style of scene tips.

Specified by:

setTipStyle in interface ISceneControl

Parameters:

style - A com.esri.arcgis.systemUI.esriTipStyle constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTipStyle

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

The style of scene tips.

Specified by:

getTipStyle in interface ISceneControl

Returns:

A com.esri.arcgis.systemUI.esriTipStyle constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTipDelay

public void setTipDelay(int delay)
                 throws java.io.IOException,
                        AutomationException

The delay before scene tips are shown.

Specified by:

setTipDelay in interface ISceneControl

Parameters:

delay - The delay (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTipDelay

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

The delay before scene tips are shown.

Specified by:

getTipDelay in interface ISceneControl

Returns:

The delay

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getKeyIntercept

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

A property that specifies interception of key strokes that are normally handled by the container. When intercepted the OnKeyDown and OnKeyUp events will be called. This value can be a combined bit mask of esriKeyIntercept enum values.

Specified by:

getKeyIntercept in interface ISceneControl

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setKeyIntercept

public void setKeyIntercept(int pVal)
                     throws java.io.IOException,
                            AutomationException

A property that specifies interception of key strokes that are normally handled by the container. When intercepted the OnKeyDown and OnKeyUp events will be called. This value can be a combined bit mask of esriKeyIntercept enum values.

Specified by:

setKeyIntercept in interface ISceneControl

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.