com.esri.arcgis.controls
Class GlobeControl

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Canvas
          extended by com.esri.arcgis.interop.Ocx
              extended by com.esri.arcgis.controls.GlobeControl
All Implemented Interfaces:
IGlobeControl, IGlobeControlDefault, ITOCBuddy, ITOCBuddy2, IToolbarBuddy, IConnectionPointContainer, IPersistStreamInit, com.esri.arcgis.interop.RemoteObjRef, IPersist, ISupportErrorInfo, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public class GlobeControl
extends com.esri.arcgis.interop.Ocx
implements com.esri.arcgis.interop.RemoteObjRef, IGlobeControlDefault, IGlobeControl, ITOCBuddy, ITOCBuddy2, IToolbarBuddy, IConnectionPointContainer, IPersistStreamInit, IPersist, ISupportErrorInfo

COM Class 'GlobeControl'. Generated 3/19/2015 1:20:47 PM from 'C:\ArcGIS\COM\esriControls.olb'

Description 'Esri GlobeControl' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class java.awt.Canvas
java.awt.Canvas.AccessibleAWTCanvas
 
Nested classes/interfaces inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
 
Fields inherited from class com.esri.arcgis.interop.Ocx
rootParentContainers, rootWindows
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Fields inherited from interface com.esri.arcgis.controls.IGlobeControlDefault
DISPID__501_GET_NAME, DISPID__501_PUT_NAME, DISPID__504_GET_NAME, DISPID__504_PUT_NAME, DISPID__514_GET_NAME, DISPID__514_PUT_NAME, DISPID__515_GET_NAME, DISPID__520_GET_NAME, DISPID__520_PUT_NAME, DISPID__521_GET_NAME, DISPID__521_PUT_NAME, DISPID__522_GET_NAME, DISPID__522_PUTREF_NAME, DISPID__552_NAME, DISPID_1_NAME, DISPID_10_GET_NAME, DISPID_10_PUT_NAME, DISPID_11_GET_NAME, DISPID_12_GET_NAME, DISPID_12_PUT_NAME, DISPID_13_GET_NAME, DISPID_13_PUT_NAME, DISPID_14_GET_NAME, DISPID_14_PUT_NAME, DISPID_15_GET_NAME, DISPID_15_PUT_NAME, DISPID_16_GET_NAME, DISPID_16_PUT_NAME, DISPID_2_GET_NAME, DISPID_3_GET_NAME, DISPID_3_PUTREF_NAME, DISPID_4_GET_NAME, DISPID_5_GET_NAME, DISPID_5_PUTREF_NAME, DISPID_6_GET_NAME, DISPID_6_PUTREF_NAME, DISPID_7_GET_NAME, DISPID_7_PUT_NAME, DISPID_8_NAME, DISPID_9_GET_NAME, DISPID_9_PUT_NAME, IID, IID9240329e_1edd_428d_afd6_356313ec9008, xxDummy
 
Fields inherited from interface com.esri.arcgis.controls.IGlobeControl
DISPID__501_GET_NAME, DISPID__501_PUT_NAME, DISPID__504_GET_NAME, DISPID__504_PUT_NAME, DISPID__514_GET_NAME, DISPID__514_PUT_NAME, DISPID__515_GET_NAME, DISPID__520_GET_NAME, DISPID__520_PUT_NAME, DISPID__521_GET_NAME, DISPID__521_PUT_NAME, DISPID__522_GET_NAME, DISPID__522_PUTREF_NAME, DISPID__552_NAME, DISPID_1_NAME, DISPID_10_GET_NAME, DISPID_10_PUT_NAME, DISPID_11_GET_NAME, DISPID_12_GET_NAME, DISPID_12_PUT_NAME, DISPID_13_GET_NAME, DISPID_13_PUT_NAME, DISPID_14_GET_NAME, DISPID_14_PUT_NAME, DISPID_15_GET_NAME, DISPID_15_PUT_NAME, DISPID_16_GET_NAME, DISPID_16_PUT_NAME, DISPID_2_GET_NAME, DISPID_3_GET_NAME, DISPID_3_PUTREF_NAME, DISPID_4_GET_NAME, DISPID_5_GET_NAME, DISPID_5_PUTREF_NAME, DISPID_6_GET_NAME, DISPID_6_PUTREF_NAME, DISPID_7_GET_NAME, DISPID_7_PUT_NAME, DISPID_8_NAME, DISPID_9_GET_NAME, DISPID_9_PUT_NAME, IID, IIDed2f6541_0842_4d2f_ae77_87f46d758f38, xxDummy
 
Fields inherited from interface com.esri.arcgis.controls.ITOCBuddy2
IID, IID05e5f0d1_7983_412a_8496_2b71863c4e0d, xxDummy
 
Fields inherited from interface com.esri.arcgis.controls.ITOCBuddy
IID5eeb268c_9b77_406d_8fc5_489324d0758b
 
Fields inherited from interface com.esri.arcgis.controls.IToolbarBuddy
IID, IIDd00f1736_7a95_4f5e_b54f_e2863c425dc3, xxDummy
 
Fields inherited from interface com.esri.arcgis.display.IConnectionPointContainer
IID, IIDb196b284_bab4_101a_b69c_00aa00341d07, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IPersistStreamInit
IID, IID7fd52380_4e07_101b_ae2d_08002b2ec713, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IPersist
IID0000010c_0000_0000_c000_000000000046
 
Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo
IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
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)
          addIGlobeControlEventsListener.
 void addITOCBuddyEventsListener(ITOCBuddyEvents theListener)
          addITOCBuddyEventsListener.
 void addNotify()
           
 boolean check3dFile(java.lang.String fileName)
          Checks if a filename is a Globe document.
 void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
          enumConnectionPoints
 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)
          findConnectionPoint
 IActiveView getActiveView()
          Returns the underlying object implementing basic map and ActiveView.
 int getAppearance()
          The appearance of the GlobeControl.
 int getBackColor()
          Background color of the GlobeControl.
 int getBorderStyle()
          The border style of the GlobeControl.
 void getClassID(GUID[] pClassID)
          getClassID
static java.lang.String getClsid()
          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.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 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)
          getSizeMax
 int getTipDelay()
          The delay before globe tips are shown.
 int getTipStyle()
          The style of globe tips.
 void initNew()
          initNew
 void interfaceSupportsErrorInfo(GUID riid)
          interfaceSupportsErrorInfo
 void isDirty()
          isDirty
 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)
          load
 void load3dFile(java.lang.String fileName)
          Loads a Globe document into the GlobeControl.
 void release()
          Release a GlobeControl.
 void removeIGlobeControlEventsListener(IGlobeControlEvents theListener)
          removeIGlobeControlEventsListener.
 void removeITOCBuddyEventsListener(ITOCBuddyEvents theListener)
          removeITOCBuddyEventsListener.
 void save(IStream pStm, int fClearDirty)
          save
 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, dispose, finalize, getCanvasWindowHandle, getControlWindowHandle, 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, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAlignmentX, getAlignmentY, getBackground, getBaseline, getBaselineResizeBehavior, 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, getMousePosition, 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, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, 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, setMaximumSize, setMinimumSize, setName, setPreferredSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle, validate
 
Methods inherited from class java.lang.Object
clone, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

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()
getClsid.


equals

public boolean equals(java.lang.Object o)
Compare this object with another

Overrides:
equals in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
Deprecated. Internal use only.

Specified by:
getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

addIGlobeControlEventsListener

public void addIGlobeControlEventsListener(IGlobeControlEvents theListener)
                                    throws java.io.IOException
addIGlobeControlEventsListener. Listen to events generated by this class.

Parameters:
theListener - An object that implements the com.esri.arcgis.controls.IGlobeControlEvents interface.
Throws:
java.io.IOException - If there are communications problems.

removeIGlobeControlEventsListener

public void removeIGlobeControlEventsListener(IGlobeControlEvents theListener)
                                       throws java.io.IOException
removeIGlobeControlEventsListener. Stop listening to events generated by this class.

Parameters:
theListener - An object that implements the com.esri.arcgis.controls.IGlobeControlEvents interface.
Throws:
java.io.IOException - If there are communications problems.

addITOCBuddyEventsListener

public void addITOCBuddyEventsListener(ITOCBuddyEvents theListener)
                                throws java.io.IOException
addITOCBuddyEventsListener. Listen to events generated by this class.

Parameters:
theListener - An object that implements the com.esri.arcgis.controls.ITOCBuddyEvents interface.
Throws:
java.io.IOException - If there are communications problems.

removeITOCBuddyEventsListener

public void removeITOCBuddyEventsListener(ITOCBuddyEvents theListener)
                                   throws java.io.IOException
removeITOCBuddyEventsListener. Stop listening to events generated by this class.

Parameters:
theListener - An object that implements the com.esri.arcgis.controls.ITOCBuddyEvents interface.
Throws:
java.io.IOException - If there are communications problems.

addNotify

public void addNotify()
Overrides:
addNotify in class com.esri.arcgis.interop.Ocx

release

public void release()
Release a GlobeControl.

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

setBackColor

public void setBackColor(int rhs1)
                  throws java.io.IOException,
                         AutomationException
Background color of the GlobeControl.

Specified by:
setBackColor in interface IGlobeControl
Specified by:
setBackColor in interface IGlobeControlDefault
Parameters:
rhs1 - The rhs1 (A COM typedef) (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBackColor

public int getBackColor()
                 throws java.io.IOException,
                        AutomationException
Background color of the GlobeControl.

Specified by:
getBackColor in interface IGlobeControl
Specified by:
getBackColor in interface IGlobeControlDefault
Returns:
The returnValue (A COM typedef)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBorderStyle

public void setBorderStyle(int rhs1)
                    throws java.io.IOException,
                           AutomationException
The border style of the GlobeControl.

Specified by:
setBorderStyle in interface IGlobeControl
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
The border style of the GlobeControl.

Specified by:
getBorderStyle in interface IGlobeControl
Specified by:
getBorderStyle in interface IGlobeControlDefault
Returns:
A com.esri.arcgis.controls.esriControlsBorderStyle constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

esri_setEnabled

public void esri_setEnabled(boolean rhs1)
                     throws java.io.IOException,
                            AutomationException
Indicates whether the GlobeControl can respond to user generated events.

Specified by:
esri_setEnabled in interface IGlobeControl
Specified by:
esri_setEnabled 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.

esri_isEnabled

public boolean esri_isEnabled()
                       throws java.io.IOException,
                              AutomationException
Indicates whether the GlobeControl can respond to user generated events.

Specified by:
esri_isEnabled in interface IGlobeControl
Specified by:
esri_isEnabled in interface IGlobeControlDefault
Returns:
The returnValue
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAppearance

public void setAppearance(int rhs1)
                   throws java.io.IOException,
                          AutomationException
The appearance of the GlobeControl.

Specified by:
setAppearance in interface IGlobeControl
Specified by:
setAppearance in interface IGlobeControlDefault
Parameters:
rhs1 - A com.esri.arcgis.controls.esriControlsAppearance constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAppearance

public int getAppearance()
                  throws java.io.IOException,
                         AutomationException
The appearance of the GlobeControl.

Specified by:
getAppearance in interface IGlobeControl
Specified by:
getAppearance in interface IGlobeControlDefault
Returns:
A com.esri.arcgis.controls.esriControlsAppearance constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMousePointer

public void setMousePointer(int rhs1)
                     throws java.io.IOException,
                            AutomationException
The mouse pointer displayed over the GlobeControl.

Specified by:
setMousePointer in interface IGlobeControl
Specified by:
setMousePointer in interface IGlobeControlDefault
Parameters:
rhs1 - A com.esri.arcgis.controls.esriControlsMousePointer constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMousePointer

public int getMousePointer()
                    throws java.io.IOException,
                           AutomationException
The mouse pointer displayed over the GlobeControl.

Specified by:
getMousePointer in interface IGlobeControl
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
Custom mouse icon used if MousePointer is 99.

Specified by:
setMouseIconByRef in interface IGlobeControl
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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMouseIcon

public Picture getMouseIcon()
                     throws java.io.IOException,
                            AutomationException
Custom mouse icon used if MousePointer is 99.

Specified by:
getMouseIcon in interface IGlobeControl
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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHWnd

public int getHWnd()
            throws java.io.IOException,
                   AutomationException
Handle to the window associated with the GlobeControl.

Specified by:
getHWnd in interface IGlobeControl
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
Displays a dialog of information about the GlobeControl.

Specified by:
aboutBox in interface IGlobeControl
Specified by:
aboutBox in interface IGlobeControlDefault
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

load3dFile

public void load3dFile(java.lang.String fileName)
                throws java.io.IOException,
                       AutomationException
Loads a Globe document into the GlobeControl.

Specified by:
load3dFile in interface IGlobeControl
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
The Globe object associated with the GlobeControl.

Specified by:
getGlobe in interface IGlobeControl
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
The GlobeDisplay object associated with the GlobeControl.

Specified by:
getGlobeDisplay in interface IGlobeControl
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
The GlobeDisplay object associated with the GlobeControl.

Specified by:
setGlobeDisplayByRef in interface IGlobeControl
Specified by:
setGlobeDisplayByRef in interface IGlobeControlDefault
Parameters:
rhs1 - A reference to a com.esri.arcgis.globecore.IGlobeDisplay (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGlobeViewer

public IGlobeViewer getGlobeViewer()
                            throws java.io.IOException,
                                   AutomationException
The GlobeViewer associated with the GlobeControl.

Specified by:
getGlobeViewer in interface IGlobeControl
Specified by:
getGlobeViewer in interface IGlobeControlDefault
Returns:
A reference to a com.esri.arcgis.globecore.IGlobeViewer
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGlobeCamera

public IGlobeCamera getGlobeCamera()
                            throws java.io.IOException,
                                   AutomationException
The GlobeCamera object associated with the GlobeControl.

Specified by:
getGlobeCamera in interface IGlobeControl
Specified by:
getGlobeCamera in interface IGlobeControlDefault
Returns:
A reference to a com.esri.arcgis.globecore.IGlobeCamera
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setGlobeCameraByRef

public void setGlobeCameraByRef(IGlobeCamera rhs1)
                         throws java.io.IOException,
                                AutomationException
The GlobeCamera object associated with the GlobeControl.

Specified by:
setGlobeCameraByRef in interface IGlobeControl
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
Current active tool for the GlobeControl. Set to nothing to clear the tool.

Specified by:
getCurrentTool in interface IGlobeControl
Specified by:
getCurrentTool in interface IGlobeControlDefault
Specified by:
getCurrentTool in interface IToolbarBuddy
Returns:
A reference to a com.esri.arcgis.systemUI.ITool
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCurrentToolByRef

public void setCurrentToolByRef(ITool rhs1)
                         throws java.io.IOException,
                                AutomationException
Current active tool for the GlobeControl. Set to nothing to clear the tool.

Specified by:
setCurrentToolByRef in interface IGlobeControl
Specified by:
setCurrentToolByRef in interface IGlobeControlDefault
Specified by:
setCurrentToolByRef in interface IToolbarBuddy
Parameters:
rhs1 - A reference to a com.esri.arcgis.systemUI.ITool (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isNavigate

public boolean isNavigate()
                   throws java.io.IOException,
                          AutomationException
Indicates if the GlobeControl performs default scene navigation in response to mouse events.

Specified by:
isNavigate in interface IGlobeControl
Specified by:
isNavigate in interface IGlobeControlDefault
Returns:
The returnValue
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setNavigate

public void setNavigate(boolean rhs1)
                 throws java.io.IOException,
                        AutomationException
Indicates if the GlobeControl performs default scene navigation in response to mouse events.

Specified by:
setNavigate in interface IGlobeControl
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
Checks if a filename is a Globe document.

Specified by:
check3dFile in interface IGlobeControl
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
A property to associate data with a control.

Specified by:
getCustomProperty in interface IGlobeControl
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
A property to associate data with a control.

Specified by:
setCustomProperty in interface IGlobeControl
Specified by:
setCustomProperty in interface IGlobeControlDefault
Parameters:
rhs1 - A Variant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDocumentFilename

public void setDocumentFilename(java.lang.String rhs1)
                         throws java.io.IOException,
                                AutomationException
The filename of the last globe document loaded into the control.

Specified by:
setDocumentFilename in interface IGlobeControl
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
The filename of the last globe document loaded into the control.

Specified by:
getDocumentFilename in interface IGlobeControl
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
A property that returns the underlying control. This can be used when the control is inside a wrapper object that has been added by a development environment.

Specified by:
getObject in interface IGlobeControl
Specified by:
getObject in interface IGlobeControlDefault
Returns:
A reference to another Automation Object (IDispatch)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOverrideBackColor

public void setOverrideBackColor(boolean rhs1)
                          throws java.io.IOException,
                                 AutomationException
Indicates whether to override the background color of the globe document.

Specified by:
setOverrideBackColor in interface IGlobeControl
Specified by:
setOverrideBackColor 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.

isOverrideBackColor

public boolean isOverrideBackColor()
                            throws java.io.IOException,
                                   AutomationException
Indicates whether to override the background color of the globe document.

Specified by:
isOverrideBackColor in interface IGlobeControl
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
Indicates the type of globe tips that are shown.

Specified by:
setShowGlobeTips in interface IGlobeControl
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
Indicates the type of globe tips that are shown.

Specified by:
getShowGlobeTips in interface IGlobeControl
Specified by:
getShowGlobeTips in interface IGlobeControlDefault
Returns:
A com.esri.arcgis.globecore.esriGlobeTipsType constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTipStyle

public void setTipStyle(int rhs1)
                 throws java.io.IOException,
                        AutomationException
The style of globe tips.

Specified by:
setTipStyle in interface IGlobeControl
Specified by:
setTipStyle in interface IGlobeControlDefault
Parameters:
rhs1 - A com.esri.arcgis.systemUI.esriTipStyle constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTipStyle

public int getTipStyle()
                throws java.io.IOException,
                       AutomationException
The style of globe tips.

Specified by:
getTipStyle in interface IGlobeControl
Specified by:
getTipStyle in interface IGlobeControlDefault
Returns:
A com.esri.arcgis.systemUI.esriTipStyle constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTipDelay

public void setTipDelay(int rhs1)
                 throws java.io.IOException,
                        AutomationException
The delay before globe tips are shown.

Specified by:
setTipDelay in interface IGlobeControl
Specified by:
setTipDelay 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.

getTipDelay

public int getTipDelay()
                throws java.io.IOException,
                       AutomationException
The delay before globe tips are shown.

Specified by:
getTipDelay in interface IGlobeControl
Specified by:
getTipDelay in interface IGlobeControlDefault
Returns:
The returnValue
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getKeyIntercept

public int getKeyIntercept()
                    throws java.io.IOException,
                           AutomationException
A property that specifies interception of key strokes that are normally handled by the container. When intercepted the OnKeyDown and OnKeyUp events will be called. This value can be a combined bit mask of esriKeyIntercept enum values.

Specified by:
getKeyIntercept in interface IGlobeControl
Specified by:
getKeyIntercept in interface IGlobeControlDefault
Returns:
The returnValue
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setKeyIntercept

public void setKeyIntercept(int rhs1)
                     throws java.io.IOException,
                            AutomationException
A property that specifies interception of key strokes that are normally handled by the container. When intercepted the OnKeyDown and OnKeyUp events will be called. This value can be a combined bit mask of esriKeyIntercept enum values.

Specified by:
setKeyIntercept in interface IGlobeControl
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
Returns the underlying object implementing basic map and ActiveView. This is used to populate the TOC.

Specified by:
getActiveView in interface ITOCBuddy
Returns:
A reference to a com.esri.arcgis.carto.IActiveView
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getScale

public double getScale(IBasicMap pBasicMap)
                throws java.io.IOException,
                       AutomationException
Returns the scale of the supplied BasicMap, this allows for objects that do not support IMap.

Specified by:
getScale in interface ITOCBuddy
Parameters:
pBasicMap - A reference to a com.esri.arcgis.carto.IBasicMap (in)
Returns:
The dScale
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

layerVisibilityChanged

public void layerVisibilityChanged(IBasicMap pBasicMap,
                                   ILayer pLayer,
                                   boolean visibility)
                            throws java.io.IOException,
                                   AutomationException
The TOCControl calls this method to instruct the buddy that layer visibility has changed.

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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isLayerValid

public boolean isLayerValid(ILayer pLayer)
                     throws java.io.IOException,
                            AutomationException
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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isLayerVisibleAtScale

public boolean isLayerVisibleAtScale(ILayer pLayer,
                                     double scale)
                              throws java.io.IOException,
                                     AutomationException
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
enumConnectionPoints

Specified by:
enumConnectionPoints in interface IConnectionPointContainer
Parameters:
ppEnum - A reference to a com.esri.arcgis.display.IEnumConnectionPoints (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findConnectionPoint

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

Specified by:
findConnectionPoint in interface IConnectionPointContainer
Parameters:
riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
ppCP - A reference to a com.esri.arcgis.display.IConnectionPoint (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDirty

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

Specified by:
isDirty in interface IPersistStreamInit
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

load

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

Specified by:
load in interface IPersistStreamInit
Parameters:
pStm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

save

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

Specified by:
save in interface IPersistStreamInit
Parameters:
pStm - A reference to a com.esri.arcgis.system.IStream (in)
fClearDirty - The fClearDirty (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

Specified by:
getSizeMax in interface IPersistStreamInit
Parameters:
pCbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

initNew

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

Specified by:
initNew in interface IPersistStreamInit
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassID

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

Specified by:
getClassID in interface IPersist
Parameters:
pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

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

Specified by:
interfaceSupportsErrorInfo in interface ISupportErrorInfo
Parameters:
riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.