com.esri.arcgis.controls
Class GlobeControl

java.lang.Object
  java.awt.Component
      java.awt.Canvas
          com.esri.arcgis.interop.Ocx
              com.esri.arcgis.controls.GlobeControl

All Implemented Interfaces:

javax.accessibility.Accessible, IConnectionPointContainer, IGlobeControl, IGlobeControlDefault, java.awt.image.ImageObserver, IPersist, IPersistStreamInit, ISupportErrorInfo, ITOCBuddy, ITOCBuddy2, IToolbarBuddy, java.awt.MenuContainer, RemoteObjRef, java.io.Serializable

public class GlobeControl

extends Ocx

implements IGlobeControlDefault, IGlobeControl, ITOCBuddy, ITOCBuddy2, IToolbarBuddy, IConnectionPointContainer, IPersistStreamInit, IPersist, ISupportErrorInfo

ESRI GlobeControl

Product Availability

Available with ArcGIS Engine.

Description

The GlobeControl encapsulates the GlobeViewer class and provides additional properties, methods and events for: managing the general appearance; loading globe documents into the control; managing the globe, globe display and globe camera properties, and setting the current tool.

Remarks

There is no need to declare the GlobeControl's outbound interface as described below in most development environments, because the interface is automaticlly implemented.

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class java.awt.Canvas

java.awt.Canvas.AccessibleAWTCanvas

Nested classes inherited from class java.awt.Component

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

Field Summary

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

rootParentContainers

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

GlobeControl()
Constructs a GlobeControl using ArcGIS Engine.

GlobeControl(java.lang.Object o)
Constructs a GlobeControl.

Method Summary

void	aboutBox() Displays a dialog of information about the GlobeControl.
void	addIGlobeControlEventsListener(IGlobeControlEvents theListener)
void	addITOCBuddyEventsListener(ITOCBuddyEvents theListener)
void	addNotify()
boolean	check3dFile(java.lang.String fileName) Checks if a filename is a Globe document.
void	enumConnectionPoints(IEnumConnectionPoints[] ppEnum) Supported Platforms
boolean	equals(java.lang.Object o) Compare this object with another
boolean	esri_isEnabled() Indicates whether the GlobeControl can respond to user generated events.
void	esri_setEnabled(boolean rhs1) Indicates whether the GlobeControl can respond to user generated events.
void	findConnectionPoint(GUID riid, IConnectionPoint[] ppCP) Supported Platforms
IActiveView	getActiveView() Returns the underlying object implementing basic map and ActiveView.
int	getAppearance() The appearance of the GlobeControl.
IConnectionPointContainer	getAsIConnectionPointContainer() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IGlobeControl	getAsIGlobeControl() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IGlobeControlDefault	getAsIGlobeControlDefault() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IPersist	getAsIPersist() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IPersistStreamInit	getAsIPersistStreamInit() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
ISupportErrorInfo	getAsISupportErrorInfo() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
ITOCBuddy	getAsITOCBuddy() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
ITOCBuddy2	getAsITOCBuddy2() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IToolbarBuddy	getAsIToolbarBuddy() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
int	getBackColor() Background color of the GlobeControl.
int	getBorderStyle() The border style of the GlobeControl.
void	getClassID(GUID[] pClassID) Supported Platforms
static java.lang.String	getClsid()
ITool	getCurrentTool() Current active tool for the GlobeControl.
java.lang.Object	getCustomProperty() A property to associate data with a control.
java.lang.String	getDocumentFilename() The filename of the last globe document loaded into the control.
IGlobe	getGlobe() The Globe object associated with the GlobeControl.
IGlobeCamera	getGlobeCamera() The GlobeCamera object associated with the GlobeControl.
IGlobeDisplay	getGlobeDisplay() The GlobeDisplay object associated with the GlobeControl.
IGlobeViewer	getGlobeViewer() The GlobeViewer associated with the GlobeControl.
int	getHWnd() Handle to the window associated with the GlobeControl.
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 GlobeControl.
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.
int	getShowGlobeTips() Indicates the type of globe tips that are shown.
void	getSizeMax(_ULARGE_INTEGER[] pCbSize) Supported Platforms
int	getTipDelay() The delay before globe tips are shown.
int	getTipStyle() The style of globe tips.
void	initNew() Supported Platforms
void	interfaceSupportsErrorInfo(GUID riid) Supported Platforms
void	isDirty() Supported Platforms
boolean	isLayerValid(ILayer pLayer) The TOCControl calls this method to ask the buddy if a layer is fully cached and valid if it cannot determine this on its own.
boolean	isLayerVisibleAtScale(ILayer pLayer, double scale) The TOCControl calls this method to ask the buddy if a layer is visible at the specified scale.
boolean	isNavigate() Indicates if the GlobeControl performs default scene navigation in response to mouse events.
boolean	isOverrideBackColor() Indicates whether to override the background color of the globe document.
void	layerVisibilityChanged(IBasicMap pBasicMap, ILayer pLayer, boolean visibility) The TOCControl calls this method to instruct the buddy that layer visibility has changed.
void	load(IStream pStm) Supported Platforms
void	load3dFile(java.lang.String fileName) Loads a Globe document into the GlobeControl.
void	removeIGlobeControlEventsListener(IGlobeControlEvents theListener)
void	removeITOCBuddyEventsListener(ITOCBuddyEvents theListener)
void	save(IStream pStm, int fClearDirty) Supported Platforms
void	setAppearance(int rhs1) The appearance of the GlobeControl.
void	setBackColor(int rhs1) Background color of the GlobeControl.
void	setBorderStyle(int rhs1) The border style of the GlobeControl.
void	setCurrentToolByRef(ITool rhs1) Current active tool for the GlobeControl.
void	setCustomProperty(java.lang.Object rhs1) A property to associate data with a control.
void	setDocumentFilename(java.lang.String rhs1) The filename of the last globe document loaded into the control.
void	setGlobeCameraByRef(IGlobeCamera rhs1) The GlobeCamera object associated with the GlobeControl.
void	setGlobeDisplayByRef(IGlobeDisplay rhs1) The GlobeDisplay object associated with the GlobeControl.
void	setKeyIntercept(int rhs1) A property that specifies interception of key strokes that are normally handled by the container.
void	setMouseIconByRef(Picture rhs1) Custom mouse icon used if MousePointer is 99.
void	setMousePointer(int rhs1) The mouse pointer displayed over the GlobeControl.
void	setNavigate(boolean rhs1) Indicates if the GlobeControl performs default scene navigation in response to mouse events.
void	setOverrideBackColor(boolean rhs1) Indicates whether to override the background color of the globe document.
void	setShowGlobeTips(int rhs1) Indicates the type of globe tips that are shown.
void	setTipDelay(int rhs1) The delay before globe tips are shown.
void	setTipStyle(int rhs1) The style of globe tips.

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

checkIfVisible, getMinimumSize, getObjRef, getPreferredSize, paint, removeNotify, setBounds, setBounds, setSize, setSize, zz_doQueuedSets, zz_get, zz_get, zz_get, zz_get, zz_get, zz_get, zz_get, zz_get, zz_queueSet, zz_queueSet, zz_queueSet, zz_queueSet, zz_queueSet, zz_queueSet, zz_queueSet, zz_queueSet

Methods inherited from class java.awt.Canvas

createBufferStrategy, createBufferStrategy, getAccessibleContext, getBufferStrategy, update

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, deliverEvent, disable, disableEvents, dispatchEvent, doLayout, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, getAlignmentX, getAlignmentY, getBackground, getBounds, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeys, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusCycleRoot, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isOpaque, isShowing, isValid, isVisible, keyDown, keyUp, layout, list, list, list, list, list, locate, location, lostFocus, minimumSize, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, paramString, postEvent, preferredSize, prepareImage, prepareImage, print, printAll, processComponentEvent, processEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeys, setFocusTraversalKeysEnabled, setFont, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

GlobeControl

public GlobeControl()

Constructs a GlobeControl using ArcGIS Engine.

GlobeControl

public GlobeControl(java.lang.Object o)

Constructs a GlobeControl.

Method Detail

getClsid

public static java.lang.String getClsid()

getAsIGlobeControlDefault

public IGlobeControlDefault getAsIGlobeControlDefault()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIGlobeControl

public IGlobeControl getAsIGlobeControl()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsITOCBuddy

public ITOCBuddy getAsITOCBuddy()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsITOCBuddy2

public ITOCBuddy2 getAsITOCBuddy2()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIToolbarBuddy

public IToolbarBuddy getAsIToolbarBuddy()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIConnectionPointContainer

public IConnectionPointContainer getAsIConnectionPointContainer()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIPersistStreamInit

public IPersistStreamInit getAsIPersistStreamInit()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIPersist

public IPersist getAsIPersist()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsISupportErrorInfo

public ISupportErrorInfo getAsISupportErrorInfo()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

addIGlobeControlEventsListener

public void addIGlobeControlEventsListener(IGlobeControlEvents theListener)
                                    throws java.io.IOException

Throws:

java.io.IOException

removeIGlobeControlEventsListener

public void removeIGlobeControlEventsListener(IGlobeControlEvents theListener)
                                       throws java.io.IOException

Throws:

java.io.IOException

addITOCBuddyEventsListener

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

Throws:

java.io.IOException

removeITOCBuddyEventsListener

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

Throws:

java.io.IOException

addNotify

public void addNotify()

Overrides:

addNotify in class Ocx

setBackColor

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

Description copied from interface: IGlobeControlDefault

Background color of the GlobeControl.

Specified by:

setBackColor in interface IGlobeControlDefault

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getBackColor

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

Description copied from interface: IGlobeControlDefault

Background color of the GlobeControl.

Description

Returns or sets the Background Color of the GlobeControl. 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 globe document, set the OverrideBackColor to true.

Specified by:

getBackColor in interface IGlobeControlDefault

Returns:

The returnValue (A COM typedef)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setBorderStyle

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

Description copied from interface: IGlobeControlDefault

The border style of the GlobeControl.

Specified by:

setBorderStyle in interface IGlobeControlDefault

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.

getBorderStyle

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

Description copied from interface: IGlobeControlDefault

The border style of the GlobeControl.

Description

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

Specified by:

getBorderStyle in interface IGlobeControlDefault

Returns:

A com.esri.arcgis.controls.esriControlsBorderStyle constant

Throws:

AutomationException - If the ArcObject component throws an exception.

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

esri_setEnabled

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

Description copied from interface: IGlobeControlDefault

Indicates whether the GlobeControl can respond to user generated events.

Specified by:

esri_setEnabled in interface IGlobeControlDefault

Parameters:

rhs1 - The rhs1 (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

esri_isEnabled

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

Description copied from interface: IGlobeControlDefault

Indicates whether the GlobeControl can respond to user generated events.

Specified by:

esri_isEnabled in interface IGlobeControlDefault

Returns:

The returnValue

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setAppearance

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

Description copied from interface: IGlobeControlDefault

The appearance of the GlobeControl.

Specified by:

setAppearance in interface IGlobeControlDefault

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getAppearance

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

Description copied from interface: IGlobeControlDefault

The appearance of the GlobeControl.

Description

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

Specified by:

getAppearance in interface IGlobeControlDefault

Returns:

A com.esri.arcgis.controls.esriControlsAppearance constant

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setMousePointer

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

Description copied from interface: IGlobeControlDefault

The mouse pointer displayed over the GlobeControl.

Specified by:

setMousePointer in interface IGlobeControlDefault

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getMousePointer

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

Description copied from interface: IGlobeControlDefault

The mouse pointer displayed over the GlobeControl.

Description

Use this property when you want to indicate changes in functionality as the mouse pointer passes over the GlobeControl. 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 IGlobeControlDefault

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

Description copied from interface: IGlobeControlDefault

Custom mouse icon used if MousePointer is 99.

Specified by:

setMouseIconByRef in interface IGlobeControlDefault

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:

AutomationException - If the ArcObject component throws an exception.

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

getMouseIcon

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

Description copied from interface: IGlobeControlDefault

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 IGlobeControlDefault

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.

getHWnd

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

Description copied from interface: IGlobeControlDefault

Handle to the window associated with the GlobeControl.

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 IGlobeControlDefault

Returns:

The returnValue

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

Description copied from interface: IGlobeControlDefault

Displays a dialog of information about the GlobeControl.

Description

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

Specified by:

aboutBox in interface IGlobeControlDefault

Throws:

AutomationException - If the ArcObject component throws an exception.

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

load3dFile

public void load3dFile(java.lang.String fileName)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IGlobeControlDefault

Loads a Globe document into the GlobeControl.

Description

Loads a globe document (*.3dd) into the GlobeControl. Use the Check3dFile method to determine if the specified globe document is a valid globe document.

Specified by:

load3dFile in interface IGlobeControlDefault

Parameters:

fileName - The fileName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGlobe

public IGlobe getGlobe()
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IGlobeControlDefault

The Globe object associated with the GlobeControl.

Description

This is a shortcut to the IGlobeDisplay::Globe property.

Specified by:

getGlobe in interface IGlobeControlDefault

Returns:

A reference to a com.esri.arcgis.globecore.IGlobe

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGlobeDisplay

public IGlobeDisplay getGlobeDisplay()
                              throws java.io.IOException,
                                     AutomationException

Description copied from interface: IGlobeControlDefault

The GlobeDisplay object associated with the GlobeControl.

Description

This is a shortcut to the IGlobeViewer::GlobeDisplay property.

Specified by:

getGlobeDisplay in interface IGlobeControlDefault

Returns:

A reference to a com.esri.arcgis.globecore.IGlobeDisplay

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setGlobeDisplayByRef

public void setGlobeDisplayByRef(IGlobeDisplay rhs1)
                          throws java.io.IOException,
                                 AutomationException

Description copied from interface: IGlobeControlDefault

The GlobeDisplay object associated with the GlobeControl.

Specified by:

setGlobeDisplayByRef in interface IGlobeControlDefault

Parameters:

rhs1 - A reference to a com.esri.arcgis.globecore.IGlobeDisplay (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getGlobeViewer

public IGlobeViewer getGlobeViewer()
                            throws java.io.IOException,
                                   AutomationException

Description copied from interface: IGlobeControlDefault

The GlobeViewer associated with the GlobeControl.

Description

This is the GlobeViewer contained within the GlobeControl.

Specified by:

getGlobeViewer in interface IGlobeControlDefault

Returns:

A reference to a com.esri.arcgis.globecore.IGlobeViewer

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getGlobeCamera

public IGlobeCamera getGlobeCamera()
                            throws java.io.IOException,
                                   AutomationException

Description copied from interface: IGlobeControlDefault

The GlobeCamera object associated with the GlobeControl.

Description

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

Specified by:

getGlobeCamera in interface IGlobeControlDefault

Returns:

A reference to a com.esri.arcgis.globecore.IGlobeCamera

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setGlobeCameraByRef

public void setGlobeCameraByRef(IGlobeCamera rhs1)
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: IGlobeControlDefault

The GlobeCamera object associated with the GlobeControl.

Specified by:

setGlobeCameraByRef in interface IGlobeControlDefault

Parameters:

rhs1 - A reference to a com.esri.arcgis.globecore.IGlobeCamera (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

Description copied from interface: IGlobeControlDefault

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

Description

The CurrentTool is the tool used to interact will the GlobeControl'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 IGlobeControlDefault

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: IGlobeControlDefault

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

Specified by:

setCurrentToolByRef in interface IGlobeControlDefault

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: IGlobeControlDefault

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

Description

The Navigate property determines whether the default GlobeControl 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 GlobeCamera.
• The GlobeControl 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 IGlobeControlDefault

Returns:

The returnValue

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setNavigate

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

Description copied from interface: IGlobeControlDefault

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

Specified by:

setNavigate in interface IGlobeControlDefault

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

check3dFile

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

Description copied from interface: IGlobeControlDefault

Checks if a filename is a Globe document.

Description

Determines whether the specified Globe Document (*.3dd) is a valid globe document and can be loaded into the GlobeControl. 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 Load3dFile to do this.

Specified by:

check3dFile in interface IGlobeControlDefault

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

Description copied from interface: IGlobeControlDefault

A property to associate data with a control.

Description

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

Specified by:

getCustomProperty in interface IGlobeControlDefault

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: IGlobeControlDefault

A property to associate data with a control.

Specified by:

setCustomProperty in interface IGlobeControlDefault

Parameters:

rhs1 - A Variant (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setDocumentFilename

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

Description copied from interface: IGlobeControlDefault

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

Specified by:

setDocumentFilename in interface IGlobeControlDefault

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

Description copied from interface: IGlobeControlDefault

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

Description

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

Specified by:

getDocumentFilename in interface IGlobeControlDefault

Returns:

The returnValue

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

Description copied from interface: IGlobeControlDefault

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 IGlobeControlDefault

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.

setOverrideBackColor

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

Description copied from interface: IGlobeControlDefault

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

Specified by:

setOverrideBackColor in interface IGlobeControlDefault

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: IGlobeControlDefault

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

Description

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

Specified by:

isOverrideBackColor in interface IGlobeControlDefault

Returns:

The returnValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setShowGlobeTips

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

Description copied from interface: IGlobeControlDefault

Indicates the type of globe tips that are shown.

Specified by:

setShowGlobeTips in interface IGlobeControlDefault

Parameters:

rhs1 - A com.esri.arcgis.globecore.esriGlobeTipsType constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getShowGlobeTips

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

Description copied from interface: IGlobeControlDefault

Indicates the type of globe tips that are shown.

Description

The type of globe tips that are displayed as the mouse moves over the globe. The globe tip can display decimal degree coordinates or elevation or a combination of both. By default the ShowGlobeTips property is set to esriGlobeTipsNone.

Specified by:

getShowGlobeTips in interface IGlobeControlDefault

Returns:

A com.esri.arcgis.globecore.esriGlobeTipsType constant

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setTipStyle

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

Description copied from interface: IGlobeControlDefault

The style of globe tips.

Specified by:

setTipStyle in interface IGlobeControlDefault

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getTipStyle

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

Description copied from interface: IGlobeControlDefault

The style of globe tips.

Description

Returns or sets the TipStyle used by the globe tips. By default the TipStyle is solid.

Specified by:

getTipStyle in interface IGlobeControlDefault

Returns:

A com.esri.arcgis.systemUI.esriTipStyle constant

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setTipDelay

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

Description copied from interface: IGlobeControlDefault

The delay before globe tips are shown.

Specified by:

setTipDelay in interface IGlobeControlDefault

Parameters:

rhs1 - The rhs1 (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getTipDelay

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

Description copied from interface: IGlobeControlDefault

The delay before globe tips are shown.

Description

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

Specified by:

getTipDelay in interface IGlobeControlDefault

Returns:

The returnValue

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getKeyIntercept

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

Description copied from interface: IGlobeControlDefault

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 GlobeControl, triggering the OnKeyDown and OnKeyUp events when pressed. These keys are often hidden from the GlobeControl 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 IGlobeControlDefault

Returns:

The returnValue

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setKeyIntercept

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

Description copied from interface: IGlobeControlDefault

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 IGlobeControlDefault

Parameters:

rhs1 - The rhs1 (in)

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.

layerVisibilityChanged

public void layerVisibilityChanged(IBasicMap pBasicMap,
                                   ILayer pLayer,
                                   boolean visibility)
                            throws java.io.IOException,
                                   AutomationException

Description copied from interface: ITOCBuddy2

The TOCControl calls this method to instruct the buddy that layer visibility has changed.

Description

The LayerVisibilityChanged method is called when the visibility of a layer is changed interactively using the TOCControl.

If a layer (typically a raster layer) within a Globe is fully cached the original data source does not need to be present in order for the layer to display. To ensure that the TOCControl changes the visibility of a cached layer the LayerVisibilityChanged method ensures the Globe changes the GlobeLayerProperties.

Specified by:

layerVisibilityChanged in interface ITOCBuddy2

Parameters:

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

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

visibility - The visibility (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isLayerValid

public boolean isLayerValid(ILayer pLayer)
                     throws java.io.IOException,
                            AutomationException

Description copied from interface: ITOCBuddy2

The TOCControl calls this method to ask the buddy if a layer is fully cached and valid if it cannot determine this on its own.

Specified by:

isLayerValid in interface ITOCBuddy2

Parameters:

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

Returns:

The isValid

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isLayerVisibleAtScale

public boolean isLayerVisibleAtScale(ILayer pLayer,
                                     double scale)
                              throws java.io.IOException,
                                     AutomationException

Description copied from interface: ITOCBuddy2

The TOCControl calls this method to ask the buddy if a layer is visible at the specified scale.

Specified by:

isLayerVisibleAtScale in interface ITOCBuddy2

Parameters:

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

scale - The scale (in)

Returns:

The visibility

Throws:

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

AutomationException - If the ArcObject component throws an exception.

enumConnectionPoints

public void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
                          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:

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 riid,
                                IConnectionPoint[] ppCP)
                         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:

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:

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.

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.

getSizeMax

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

Description copied from interface: IPersistStreamInit

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStreamInit

Parameters:

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

getClassID

public void getClassID(GUID[] pClassID)
                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:

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

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                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:

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