com.esri.arcgis.beans.scene
Class SceneBean

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              com.esri.arcgis.beans.scene.SceneBean

All Implemented Interfaces:

BuddyControl, ISceneControl, ISceneControlDefault, ITOCBuddy, IToolbarBuddy, IConnectionPointContainer, IPersistStreamInit, com.esri.arcgis.interop.RemoteObjRef, IPersist, ISupportErrorInfo, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

public class SceneBean
extends javax.swing.JComponent
implements BuddyControl, com.esri.arcgis.interop.RemoteObjRef, ISceneControlDefault, ISceneControl, ITOCBuddy, IToolbarBuddy, IConnectionPointContainer, IPersistStreamInit, IPersist, ISupportErrorInfo

The SceneBean is a wrapper class of SceneControl to facilitate the use of SceneControl at the design time. Users could access the actual control by getSceneControl method.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

protected SceneControl

m_sceneControl

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface com.esri.arcgis.controls.ISceneControlDefault

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, IID6f7c3afd_ee18_4633_8611_a2aa3cfb869b, xxDummy

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, xxDummy

Fields inherited from interface com.esri.arcgis.controls.ITOCBuddy

IID, IID5eeb268c_9b77_406d_8fc5_489324d0758b, xxDummy

Fields inherited from interface com.esri.arcgis.controls.IToolbarBuddy

IID, IIDd00f1736_7a95_4f5e_b54f_e2863c425dc3, xxDummy

Fields inherited from interface com.esri.arcgis.display.IConnectionPointContainer

IID, IIDb196b284_bab4_101a_b69c_00aa00341d07, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IPersistStreamInit

IID, IID7fd52380_4e07_101b_ae2d_08002b2ec713, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersist

IID0000010c_0000_0000_c000_000000000046

Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

SceneBean()
Default constructor

Method Summary

void	aboutBox() Displays a dialog of information about the SceneControl.
void	addISceneControlEventsListener(ISceneControlEventsAdapter theListener)
void	addITOCBuddyEventsListener(ITOCBuddyEventsAdapter theListener)
boolean	checkSxFile(java.lang.String filename) Checks if a filename is a scene document.
void	enumConnectionPoints(IEnumConnectionPoints[] iEnumConnectionPointsArray) enumConnectionPoints
boolean	esri_isEnabled() Indicates whether the SceneControl can respond to user generated events.
void	esri_setEnabled(boolean rhs1) Indicates whether the SceneControl can respond to user generated events.
void	findConnectionPoint(GUID gUID, IConnectionPoint[] iConnectionPointArray) findConnectionPoint
IActiveView	getActiveView() Returns the underlying object implementing basic map and ActiveView.
int	getAppearance() The appearance of the SceneControl.
int	getBackColor() Background color of the SceneControl.
int	getBorderStyle() The border style of the SceneControl.
java.lang.Object	getBuddyControl()
ICamera	getCamera() The Camera object associated with the SceneControl.
void	getClassID(GUID[] gUIDArray) getClassID
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.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch()
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.
double	getScale(IBasicMap pBasicMap) Returns the scale of the supplied BasicMap, this allows for objects that do not support IMap.
IScene	getScene() The Scene object associated with the SceneControl.
SceneControl	getSceneControl() Returns the actual SceneControl
ISceneGraph	getSceneGraph() The SceneGraph object associated with the SceneControl.
ISceneViewer	getSceneViewer() The SceneViewer associated with the SceneControl.
void	getSizeMax(_ULARGE_INTEGER[] _ULARGE_INTEGERArray) getSizeMax
int	getTipDelay() The delay before scene tips are shown.
int	getTipStyle() The style of scene tips.
void	initNew() initNew
void	interfaceSupportsErrorInfo(GUID gUID) interfaceSupportsErrorInfo
void	isDirty() isDirty
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	load(IStream pStm) load
void	loadSxFile(java.lang.String sxPath) Loads a scene document into the SceneControl.
void	paint(java.awt.Graphics g) Paints this component.
void	release()
void	removeISceneControlEventsListener(ISceneControlEventsAdapter theListener)
void	removeITOCBuddyEventsListener(ITOCBuddyEventsAdapter theListener)
void	save(IStream pStm, int fClearDirty) save
void	setAppearance(int appearance) The appearance of the SceneControl.
void	setBackColor(int rhs1) Background color of the SceneControl.
void	setBorderStyle(int rhs1) The border style of the SceneControl.
void	setCameraByRef(ICamera rhs1) The Camera object associated with the SceneControl.
void	setCurrentToolByRef(ITool rhs1) Current active tool for the SceneControl.
void	setCustomProperty(java.lang.Object rhs1) A property to associate data with a control.
void	setDocumentFilename(java.lang.String filename) The filename of the last scene document loaded into the control.
void	setKeyIntercept(int key) A property that specifies interception of key strokes that are normally handled by the container.
void	setLayout(java.awt.LayoutManager layout) Overrides the setLayout method of super class.
void	setMouseIconByRef(Picture picture) Custom mouse icon used if MousePointer is 99.
void	setMousePointer(int pointer) The mouse pointer displayed over the SceneControl.
void	setNavigate(boolean rhs1) Indicates if the SceneControl performs default scene navigation in response to mouse events.
void	setOverrideBackColor(boolean rhs1) Indicates whether to override the background color of the scene document.
void	setSceneGraphByRef(ISceneGraph rhs1) The SceneGraph object associated with the SceneControl.
void	setShowSceneTips(boolean rhs1) Indicates if scene tips are shown.
void	setTipDelay(int rhs1) The delay before scene tips are shown.
void	setTipStyle(int style) The style of scene tips.

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, transferFocusBackward, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

m_sceneControl

protected SceneControl m_sceneControl

Constructor Detail

SceneBean

public SceneBean()

Default constructor

Method Detail

setLayout

public void setLayout(java.awt.LayoutManager layout)

Overrides the setLayout method of super class.

Overrides:

setLayout in class java.awt.Container

Parameters:

layout - LayoutManager - a LayoutManager object.

getSceneControl

public SceneControl getSceneControl()

Returns the actual SceneControl

Returns:

SceneControl

paint

public void paint(java.awt.Graphics g)

Paints this component.

Overrides:

paint in class javax.swing.JComponent

Parameters:

g - the graphics context to use for painting

getBuddyControl

public java.lang.Object getBuddyControl()

Specified by:

getBuddyControl in interface BuddyControl

getAppearance

public int getAppearance()
                  throws java.io.IOException

The appearance of the SceneControl.

Specified by:

getAppearance in interface ISceneControl

Specified by:

getAppearance in interface ISceneControlDefault

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.

setAppearance

public void setAppearance(int appearance)
                   throws java.io.IOException

The appearance of the SceneControl.

Specified by:

setAppearance in interface ISceneControl

Specified by:

setAppearance in interface ISceneControlDefault

Parameters:

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

getBorderStyle

public int getBorderStyle()
                   throws java.io.IOException

The border style of the SceneControl.

Specified by:

getBorderStyle in interface ISceneControl

Specified by:

getBorderStyle in interface ISceneControlDefault

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.

setBorderStyle

public void setBorderStyle(int rhs1)
                    throws java.io.IOException

The border style of the SceneControl.

Specified by:

setBorderStyle in interface ISceneControl

Specified by:

setBorderStyle in interface ISceneControlDefault

Parameters:

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

getMousePointer

public int getMousePointer()
                    throws java.io.IOException

The mouse pointer displayed over the SceneControl.

Specified by:

getMousePointer in interface ISceneControl

Specified by:

getMousePointer in interface ISceneControlDefault

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.

setMousePointer

public void setMousePointer(int pointer)
                     throws java.io.IOException

The mouse pointer displayed over the SceneControl.

Specified by:

setMousePointer in interface ISceneControl

Specified by:

setMousePointer in interface ISceneControlDefault

Parameters:

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

getTipStyle

public int getTipStyle()
                throws java.io.IOException

The style of scene tips.

Specified by:

getTipStyle in interface ISceneControl

Specified by:

getTipStyle in interface ISceneControlDefault

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.

setTipStyle

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

The style of scene tips.

Specified by:

setTipStyle in interface ISceneControl

Specified by:

setTipStyle in interface ISceneControlDefault

Parameters:

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

esri_isEnabled

public boolean esri_isEnabled()
                       throws java.io.IOException

Indicates whether the SceneControl can respond to user generated events.

Specified by:

esri_isEnabled in interface ISceneControl

Specified by:

esri_isEnabled in interface ISceneControlDefault

Returns:

The returnValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

esri_setEnabled

public void esri_setEnabled(boolean rhs1)
                     throws java.io.IOException

Indicates whether the SceneControl can respond to user generated events.

Specified by:

esri_setEnabled in interface ISceneControl

Specified by:

esri_setEnabled in interface ISceneControlDefault

Parameters:

rhs1 - The rhs1 (in)

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

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

Specified by:

getKeyIntercept in interface ISceneControlDefault

Returns:

The returnValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setKeyIntercept

public void setKeyIntercept(int key)
                     throws java.io.IOException

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

Specified by:

setKeyIntercept in interface ISceneControlDefault

Parameters:

rhs1 - The rhs1 (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

Background color of the SceneControl.

Specified by:

getBackColor in interface ISceneControl

Specified by:

getBackColor in interface ISceneControlDefault

Returns:

The returnValue (A COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBackColor

public void setBackColor(int rhs1)
                  throws java.io.IOException

Background color of the SceneControl.

Specified by:

setBackColor in interface ISceneControl

Specified by:

setBackColor in interface ISceneControlDefault

Parameters:

rhs1 - The rhs1 (A COM typedef) (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 filename)
                         throws java.io.IOException

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

Specified by:

setDocumentFilename in interface ISceneControl

Specified by:

setDocumentFilename in interface ISceneControlDefault

Parameters:

rhs1 - The rhs1 (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

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

Specified by:

getDocumentFilename in interface ISceneControl

Specified by:

getDocumentFilename in interface ISceneControlDefault

Returns:

The returnValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addISceneControlEventsListener

public void addISceneControlEventsListener(ISceneControlEventsAdapter theListener)
                                    throws java.io.IOException

Throws:

java.io.IOException

removeISceneControlEventsListener

public void removeISceneControlEventsListener(ISceneControlEventsAdapter theListener)
                                       throws java.io.IOException

Throws:

java.io.IOException

addITOCBuddyEventsListener

public void addITOCBuddyEventsListener(ITOCBuddyEventsAdapter theListener)
                                throws java.io.IOException

Throws:

java.io.IOException

removeITOCBuddyEventsListener

public void removeITOCBuddyEventsListener(ITOCBuddyEventsAdapter theListener)
                                   throws java.io.IOException

Throws:

java.io.IOException

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

Specified by:

getObject in interface ISceneControlDefault

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.

getHWnd

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

Handle to the window associated with the SceneControl.

Specified by:

getHWnd in interface ISceneControl

Specified by:

getHWnd in interface ISceneControlDefault

Returns:

The returnValue

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

Specified by:

loadSxFile in interface ISceneControlDefault

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

Specified by:

getScene in interface ISceneControlDefault

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

Specified by:

getSceneGraph in interface ISceneControlDefault

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 rhs1)
                        throws java.io.IOException,
                               AutomationException

The SceneGraph object associated with the SceneControl.

Specified by:

setSceneGraphByRef in interface ISceneControl

Specified by:

setSceneGraphByRef in interface ISceneControlDefault

Parameters:

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

Specified by:

getSceneViewer in interface ISceneControlDefault

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

Specified by:

getCamera in interface ISceneControlDefault

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 rhs1)
                    throws java.io.IOException,
                           AutomationException

The Camera object associated with the SceneControl.

Specified by:

setCameraByRef in interface ISceneControl

Specified by:

setCameraByRef in interface ISceneControlDefault

Parameters:

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

Specified by:

getCurrentTool in interface ISceneControlDefault

Specified by:

getCurrentTool in interface IToolbarBuddy

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 rhs1)
                         throws java.io.IOException,
                                AutomationException

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

Specified by:

setCurrentToolByRef in interface ISceneControl

Specified by:

setCurrentToolByRef in interface ISceneControlDefault

Specified by:

setCurrentToolByRef in interface IToolbarBuddy

Parameters:

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

Specified by:

isNavigate in interface ISceneControlDefault

Returns:

The returnValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setNavigate

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

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

Specified by:

setNavigate in interface ISceneControl

Specified by:

setNavigate in interface ISceneControlDefault

Parameters:

rhs1 - The rhs1 (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

Specified by:

checkSxFile in interface ISceneControlDefault

Parameters:

fileName - The fileName (in)

Returns:

The returnValue

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

Specified by:

getCustomProperty in interface ISceneControlDefault

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 rhs1)
                       throws java.io.IOException,
                              AutomationException

A property to associate data with a control.

Specified by:

setCustomProperty in interface ISceneControl

Specified by:

setCustomProperty in interface ISceneControlDefault

Parameters:

rhs1 - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setOverrideBackColor

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

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

Specified by:

setOverrideBackColor in interface ISceneControl

Specified by:

setOverrideBackColor in interface ISceneControlDefault

Parameters:

rhs1 - The rhs1 (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

Specified by:

isOverrideBackColor in interface ISceneControlDefault

Returns:

The returnValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setShowSceneTips

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

Indicates if scene tips are shown.

Specified by:

setShowSceneTips in interface ISceneControl

Specified by:

setShowSceneTips in interface ISceneControlDefault

Parameters:

rhs1 - The rhs1 (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

Specified by:

isShowSceneTips in interface ISceneControlDefault

Returns:

The returnValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTipDelay

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

The delay before scene tips are shown.

Specified by:

setTipDelay in interface ISceneControl

Specified by:

setTipDelay in interface ISceneControlDefault

Parameters:

rhs1 - The rhs1 (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

Specified by:

getTipDelay in interface ISceneControlDefault

Returns:

The returnValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getActiveView

public IActiveView getActiveView()
                          throws java.io.IOException,
                                 AutomationException

Returns the underlying object implementing basic map and ActiveView. This is used to populate the TOC.

Specified by:

getActiveView in interface ITOCBuddy

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getScale

public double getScale(IBasicMap pBasicMap)
                throws java.io.IOException,
                       AutomationException

Returns the scale of the supplied BasicMap, this allows for objects that do not support IMap.

Specified by:

getScale in interface ITOCBuddy

Parameters:

pBasicMap - A reference to a com.esri.arcgis.carto.IBasicMap (in)

Returns:

The dScale

Throws:

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

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pStm)
          throws java.io.IOException,
                 AutomationException

load

Specified by:

load in interface IPersistStreamInit

Parameters:

pStm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pStm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException

save

Specified by:

save in interface IPersistStreamInit

Parameters:

pStm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Specified by:

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

release

public void release()

Specified by:

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

setMouseIconByRef

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

Custom mouse icon used if MousePointer is 99.

Specified by:

setMouseIconByRef in interface ISceneControl

Specified by:

setMouseIconByRef in interface ISceneControlDefault

Parameters:

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

Specified by:

getMouseIcon in interface ISceneControlDefault

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.

aboutBox

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

Displays a dialog of information about the SceneControl.

Specified by:

aboutBox in interface ISceneControl

Specified by:

aboutBox in interface ISceneControlDefault

Throws:

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

AutomationException - If the ArcObject component throws an exception.

enumConnectionPoints

public void enumConnectionPoints(IEnumConnectionPoints[] iEnumConnectionPointsArray)
                          throws java.io.IOException,
                                 AutomationException

enumConnectionPoints

Specified by:

enumConnectionPoints in interface IConnectionPointContainer

Parameters:

ppEnum - A reference to a com.esri.arcgis.display.IEnumConnectionPoints (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

findConnectionPoint

public void findConnectionPoint(GUID gUID,
                                IConnectionPoint[] iConnectionPointArray)
                         throws java.io.IOException,
                                AutomationException

findConnectionPoint

Specified by:

findConnectionPoint in interface IConnectionPointContainer

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

ppCP - A reference to a com.esri.arcgis.display.IConnectionPoint (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] gUIDArray)
                throws java.io.IOException,
                       AutomationException

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDirty

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

isDirty

Specified by:

isDirty in interface IPersistStreamInit

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] _ULARGE_INTEGERArray)
                throws java.io.IOException,
                       AutomationException

getSizeMax

Specified by:

getSizeMax in interface IPersistStreamInit

Parameters:

pCbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

initNew

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

initNew

Specified by:

initNew in interface IPersistStreamInit

Throws:

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

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID gUID)
                                throws java.io.IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.