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, IConnectionPointContainer, java.awt.image.ImageObserver, IPersist, IPersistStreamInit, ISceneControl, ISceneControlDefault, ISupportErrorInfo, ITOCBuddy, IToolbarBuddy, java.awt.MenuContainer, RemoteObjRef, java.io.Serializable

public class SceneBean

extends javax.swing.JComponent

implements BuddyControl, 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 inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, 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 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) Supported Platforms
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) Supported Platforms
IActiveView	getActiveView() Returns the underlying object implementing basic map and ActiveView.
int	getAppearance() The appearance of the SceneControl.
IConnectionPointContainer	getAsIConnectionPointContainer()
IPersist	getAsIPersist()
IPersistStreamInit	getAsIPersistStreamInit()
ISceneControl	getAsISceneControl()
ISceneControlDefault	getAsISceneControlDefault()
ISupportErrorInfo	getAsISupportErrorInfo()
ITOCBuddy	getAsITOCBuddy()
IToolbarBuddy	getAsIToolbarBuddy()
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) Supported Platforms
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.
Dispatch	getJintegraDispatch() Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.
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) Supported Platforms
int	getTipDelay() The delay before scene tips are shown.
int	getTipStyle() The style of scene tips.
void	initNew() Supported Platforms
void	interfaceSupportsErrorInfo(GUID gUID) Supported Platforms
void	isDirty() Supported Platforms
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) Supported Platforms
void	loadSxFile(java.lang.String sxPath) Loads a scene document into the SceneControl.
void	paint(java.awt.Graphics g) Paints this component.
void	release() Release this COM object reference
void	removeISceneControlEventsListener(ISceneControlEventsAdapter theListener)
void	removeITOCBuddyEventsListener(ITOCBuddyEventsAdapter theListener)
void	save(IStream pStm, int fClearDirty) Supported Platforms
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, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, 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, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, 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, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, 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, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, 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.

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.

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

Description copied from interface: ISceneControlDefault

The appearance of the SceneControl.

Description

Returns or sets the paint style of a SceneControl to either Flat or 3D. By default the appearance is flat.

Specified by:

getAppearance in interface ISceneControlDefault

Returns:

A com.esri.arcgis.controls.esriControlsAppearance constant

Throws:

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

setAppearance

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

Description copied from interface: ISceneControlDefault

The appearance of the SceneControl.

Specified by:

setAppearance in interface ISceneControlDefault

Parameters:

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

Throws:

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

getBorderStyle

public int getBorderStyle()
                   throws java.io.IOException

Description copied from interface: ISceneControlDefault

The border style of the SceneControl.

Description

Returns or sets the border style of a SceneControl. By default a border is drawn.

Specified by:

getBorderStyle in interface ISceneControlDefault

Returns:

A com.esri.arcgis.controls.esriControlsBorderStyle constant

Throws:

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

setBorderStyle

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

Description copied from interface: ISceneControlDefault

The border style of the SceneControl.

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.

getMousePointer

public int getMousePointer()
                    throws java.io.IOException

Description copied from interface: ISceneControlDefault

The mouse pointer displayed over the SceneControl.

Description

Use this property when you want to indicate changes in functionality as the mouse pointer passes over the SceneControl. The esriPointerArrowHourglass setting (11) is useful for indicating that the user should wait for a process or operation to finish.

Specified by:

getMousePointer in interface ISceneControlDefault

Returns:

A com.esri.arcgis.controls.esriControlsMousePointer constant

Throws:

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

setMousePointer

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

Description copied from interface: ISceneControlDefault

The mouse pointer displayed over the SceneControl.

Specified by:

setMousePointer in interface ISceneControlDefault

Parameters:

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

Throws:

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

getTipStyle

public int getTipStyle()
                throws java.io.IOException

Description copied from interface: ISceneControlDefault

The style of scene tips.

Description

Returns or sets the TipStyle used by the scene tips when ShowSceneTips is set to true to either solid or transparent. By default the TipStyle is solid.

Specified by:

getTipStyle in interface ISceneControlDefault

Returns:

A com.esri.arcgis.systemUI.esriTipStyle constant

Throws:

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

setTipStyle

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

Description copied from interface: ISceneControlDefault

The style of scene tips.

Specified by:

setTipStyle in interface ISceneControlDefault

Parameters:

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

Throws:

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

esri_isEnabled

public boolean esri_isEnabled()
                       throws java.io.IOException

Description copied from interface: ISceneControlDefault

Indicates whether the SceneControl can respond to user generated events.

Specified by:

esri_isEnabled in interface ISceneControlDefault

Returns:

The returnValue

Throws:

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

esri_setEnabled

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

Description copied from interface: ISceneControlDefault

Indicates whether the SceneControl can respond to user generated events.

Specified by:

esri_setEnabled in interface ISceneControlDefault

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

getKeyIntercept

public int getKeyIntercept()
                    throws java.io.IOException

Description copied from interface: ISceneControlDefault

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.

Description

Returns or sets keys on the keyboard that will be intercepted by the SceneControl, triggering the OnKeyDown and OnKeyUp events when pressed. These keys are often hidden from the SceneControl by the development environment container. By default the KeyIntercept is set to esriKeyInterceptNone.

Many development environment containers use the up, down, left and right arrow keys to change control focus on a form. These keys can also be useful for navigating around the display. To intercept the arrow keys and the Tab key combine the enum values using a logical OR operation (esriKeyInterceptArrowKeys OR esriKeyInterceptTabKey, which is 1 OR 4 = 5).

Specified by:

getKeyIntercept in interface ISceneControlDefault

Returns:

The returnValue

Throws:

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

setKeyIntercept

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

Description copied from interface: ISceneControlDefault

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 ISceneControlDefault

Parameters:

key - The rhs1 (in)

Throws:

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

getBackColor

public int getBackColor()
                 throws java.io.IOException

Description copied from interface: ISceneControlDefault

Background color of the SceneControl.

Description

Returns or sets the Background Color of the SceneControl. Internally the OLE_Color is stored as a long integer where the value may be calculated for any RGB combination as follows:

OLE_Color = (Red) + (Green * 256) + (Blue * 256 * 256)

Where Red, Green and Blue are Long Integers within the range 0 - 255.

To ensure the BackColor property overrides any background color set in a scene document, set the OverrideBackColor to true.

Specified by:

getBackColor in interface ISceneControlDefault

Returns:

The returnValue (A COM typedef)

Throws:

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

setBackColor

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

Description copied from interface: ISceneControlDefault

Background color of the SceneControl.

Specified by:

setBackColor in interface ISceneControlDefault

Parameters:

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

Throws:

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

setDocumentFilename

public void setDocumentFilename(java.lang.String filename)
                         throws java.io.IOException

Description copied from interface: ISceneControlDefault

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

Specified by:

setDocumentFilename in interface ISceneControlDefault

Parameters:

filename - The rhs1 (in)

Throws:

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

getDocumentFilename

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

Description copied from interface: ISceneControlDefault

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

Description

Returns the DocumentFilename of the last document loaded into the SceneControl with the LoadSxFile method. An empty string will be returned if no document is loaded.

Specified by:

getDocumentFilename in interface ISceneControlDefault

Returns:

The returnValue

Throws:

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

getAsISceneControlDefault

public ISceneControlDefault getAsISceneControlDefault()

getAsISceneControl

public ISceneControl getAsISceneControl()

getAsITOCBuddy

public ITOCBuddy getAsITOCBuddy()

getAsIToolbarBuddy

public IToolbarBuddy getAsIToolbarBuddy()

getAsIConnectionPointContainer

public IConnectionPointContainer getAsIConnectionPointContainer()

getAsIPersistStreamInit

public IPersistStreamInit getAsIPersistStreamInit()

getAsIPersist

public IPersist getAsIPersist()

getAsISupportErrorInfo

public ISupportErrorInfo getAsISupportErrorInfo()

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

Description copied from interface: ISceneControlDefault

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.

Description

In some development environments it is not possible to query interface directly on the control to other COM interfaces, beacuse the control is contained within a wrapper object. To get the real control use the Object property.

Specified by:

getObject in interface ISceneControlDefault

Returns:

A reference to another Automation Object (IDispatch)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getHWnd

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

Description copied from interface: ISceneControlDefault

Handle to the window associated with the SceneControl.

Description

The operating environment identifies each window, form and control in an application by assigning it a handle, or hWnd. Many ArcObjects methods and Windows API calls require the hWnd as an argument.

Specified by:

getHWnd in interface ISceneControlDefault

Returns:

The returnValue

Throws:

AutomationException - If the ArcObject component throws an exception.

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

loadSxFile

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

Description copied from interface: ISceneControlDefault

Loads a scene document into the SceneControl.

Description

Loads a Scene document (*.sxd) into the SceneControl. Use the CheckSxFile method to determine if the specified scene document is a valid scene document.

Specified by:

loadSxFile in interface ISceneControlDefault

Parameters:

sxPath - The sxPath (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getScene

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

Description copied from interface: ISceneControlDefault

The Scene object associated with the SceneControl.

Description

This is a shortcut to the ISceneGraph::Scene property.

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

Description copied from interface: ISceneControlDefault

The SceneGraph object associated with the SceneControl.

Description

This is a shortcut to the ISceneViewer::SceneGraph property.

Specified by:

getSceneGraph in interface ISceneControlDefault

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setSceneGraphByRef

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

Description copied from interface: ISceneControlDefault

The SceneGraph object associated with the SceneControl.

Specified by:

setSceneGraphByRef in interface ISceneControlDefault

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getSceneViewer

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

Description copied from interface: ISceneControlDefault

The SceneViewer associated with the SceneControl.

Description

This is the SceneViewer contained within the SceneControl.

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

Description copied from interface: ISceneControlDefault

The Camera object associated with the SceneControl.

Description

This is a shortcut to the ISceneViewer::Camera property.

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

Description copied from interface: ISceneControlDefault

The Camera object associated with the SceneControl.

Specified by:

setCameraByRef in interface ISceneControlDefault

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getCurrentTool

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

Description copied from interface: ISceneControlDefault

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

Description

The CurrentTool is the tool used to interact will the SceneControl's display. Always check if a tool is enabled before setting it to the CurrentTool property, otherwise a user will be able to use a tool that is actually disabled.

Remarks

When the CurrentTool is set the following events occur:

1. The ITool::Deactivate event is triggered on the 'old' CurrentTool if one was set. If this event returns false a trappable error ocurrs. If this event returns true the 'old' CurrentTool is removed and replaced.
2. The ICommand::OnClick event is triggered on the 'new' CurrentTool and its cursor is picked up.

Within an ITool implementation it is recommended that the ITool::Deactivate event returns true. This allows a 'new' CurrentTool to be set, and allows the release of the CurrentTool when an application is shutting down.

Specified by:

getCurrentTool in interface ISceneControlDefault

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

Description copied from interface: ISceneControlDefault

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

Specified by:

setCurrentToolByRef in interface ISceneControlDefault

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

Description copied from interface: ISceneControlDefault

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

Description

The Navigate property determines whether the default SceneControl navigation functionality is enabled at run time. By default the Navigate property is set to false. When the Navigate property is set to true, the end user can use the left mouse button to navigate backwards and forwards and to the left and right of the display, and the right mouse button to zoom in and out on the display.

Remarks

When the Navigate property is set to true, the OnMouseDown, OnMouseMove, OnMouseUp events are being intercepted. As such, care must be taken by developers to avoid the display becoming confused when:

• The OnMouseDown, OnMouseMove, OnMouseUp events contain code that interacts with the Camera.
• The SceneControl is being used in conjunction with the ToolbarControl with Control Commands or custom commands hosted on it. When a command hosted on the ToolbarControl is selected by the end user to become the CurrentTool, both the Navigate functionality and the CurrentTool are catching the OnMouseDown, OnMouseMove, OnMouseUp events.

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

Description copied from interface: ISceneControlDefault

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

Specified by:

setNavigate in interface ISceneControlDefault

Parameters:

rhs1 - The rhs1 (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

checkSxFile

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

Description copied from interface: ISceneControlDefault

Checks if a filename is a scene document.

Description

Determines whether the specified Scene Document (*.sxd) is a valid scene document and can be loaded into the SceneControl. The method verifies the file exists and verifies the file internals conform to an expected storage format. The method does not read and validate the entire contents of the file; use the LoadSxFile to do this.

Specified by:

checkSxFile in interface ISceneControlDefault

Parameters:

filename - The fileName (in)

Returns:

The returnValue

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getCustomProperty

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

Description copied from interface: ISceneControlDefault

A property to associate data with a control.

Description

Use the CustomProperty to associate any useful data with the SceneControl. This is similar to a 'Tag' property, and can be use to store strings, numbers and objects.

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

Description copied from interface: ISceneControlDefault

A property to associate data with a control.

Specified by:

setCustomProperty in interface ISceneControlDefault

Parameters:

rhs1 - A Variant (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setOverrideBackColor

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

Description copied from interface: ISceneControlDefault

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

Specified by:

setOverrideBackColor in interface ISceneControlDefault

Parameters:

rhs1 - The rhs1 (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isOverrideBackColor

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

Description copied from interface: ISceneControlDefault

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

Description

The OverrideBackColor property determines whether the background color of any document loaded into the SceneControl is overriden and replaced with the SceneControl's BackColor. By default this property is false.

Specified by:

isOverrideBackColor in interface ISceneControlDefault

Returns:

The returnValue

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setShowSceneTips

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

Description copied from interface: ISceneControlDefault

Indicates if scene tips are shown.

Specified by:

setShowSceneTips in interface ISceneControlDefault

Parameters:

rhs1 - The rhs1 (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isShowSceneTips

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

Description copied from interface: ISceneControlDefault

Indicates if scene tips are shown.

Description

Determines whether scene tips are displayed (if they exist) as the mouse moves over layer features. By default the ShowSceneTips property is set to false.

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

Description copied from interface: ISceneControlDefault

The delay before scene tips are shown.

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

Description copied from interface: ISceneControlDefault

The delay before scene tips are shown.

Description

Returns or sets the time delay in milliseconds before scene tips are displayed. By default TipDelay is 500 milliseconds.

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

Description copied from interface: ITOCBuddy

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

Description

The GetActiveView method returns the IActiveView interface of the ITOCControl::Buddy. This will either be a Map, PageLayout, Scene or Globe.

Specified by:

getActiveView in interface ITOCBuddy

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getScale

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

Description copied from interface: ITOCBuddy

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

Description

The GetScale method returns scale of the supplied Map or Scene. If the scale is unknown the GetScale method returns 0.0.

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

Description copied from interface: IPersistStreamInit

Supported Platforms

Windows, Solaris, Linux

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

Description copied from interface: IPersistStreamInit

Supported Platforms

Windows, Solaris, Linux

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 Dispatch getJintegraDispatch()

Description copied from interface: RemoteObjRef

Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.

Specified by:

getJintegraDispatch in interface RemoteObjRef

Returns:

the COM object reference

release

public void release()

Description copied from interface: RemoteObjRef

Release this COM object reference

Specified by:

release in interface RemoteObjRef

setMouseIconByRef

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

Description copied from interface: ISceneControlDefault

Custom mouse icon used if MousePointer is 99.

Specified by:

setMouseIconByRef in interface ISceneControlDefault

Parameters:

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

Description copied from interface: ISceneControlDefault

Custom mouse icon used if MousePointer is 99.

Description

The MouseIcon property provides a custom icon that is used when the MousePointer property is set to esriPointerArrowHourglass (99).

Remarks

In most development evironments the control's property pages can be used to load either a cursor (.cur) or icon (.ico) file. A cursor contains a custom 'hotspot' location and can be any size. The 'hotspot' location for an icon file defaults to the center of the icon. This property cannot be used to load animated cursor (.ani) files.

To programatically create an object implementing IPictureDisp there is the win32 function OleLoadPicture or helper methods depending on the development environment.

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:

AutomationException - If the ArcObject component throws an exception.

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

aboutBox

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

Description copied from interface: ISceneControlDefault

Displays a dialog of information about the SceneControl.

Description

The AboutBox method causes a modal dialog box to display on top of the SceneControl, containing information about the version and creation date of the SceneControl as well as listing relevant legal and copyright information from ESRI.

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

Description copied from interface: IConnectionPointContainer

Supported Platforms

Windows, Solaris, Linux

Description

IConnectionPointContainer is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:

enumConnectionPoints in interface IConnectionPointContainer

Parameters:

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

Description copied from interface: IConnectionPointContainer

Supported Platforms

Windows, Solaris, Linux

Description

IConnectionPointContainer is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:

findConnectionPoint in interface IConnectionPointContainer

Parameters:

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

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getClassID

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

Description copied from interface: IPersist

Supported Platforms

Windows, Solaris, Linux

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:

getClassID in interface IPersist

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isDirty

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

Description copied from interface: IPersistStreamInit

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStreamInit

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getSizeMax

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

Description copied from interface: IPersistStreamInit

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStreamInit

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

initNew

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

Description copied from interface: IPersistStreamInit

Supported Platforms

Windows, Solaris, Linux

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

Description copied from interface: ISupportErrorInfo

Supported Platforms

Windows, Solaris, Linux

Description

Indicates whether the interface supports IErrorInfo.

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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