com.esri.arcgis.controls
Class ArcReaderGlobeControl

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.ArcReaderGlobeControl
All Implemented Interfaces:
IARGlobeControl, IARGlobeControlDefault, com.esri.arcgis.interop.RemoteObjRef, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public class ArcReaderGlobeControl
extends com.esri.arcgis.interop.Ocx
implements com.esri.arcgis.interop.RemoteObjRef, IARGlobeControl, IARGlobeControlDefault

COM Class 'ArcReaderGlobeControl'. Generated 3/19/2015 1:20:50 PM from 'C:\ArcGIS\COM\esriPublisherControls.olb'

Description 'Esri ArcReaderGlobeControl' 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.IARGlobeControl
DISPID__504_GET_NAME, DISPID__504_PUT_NAME, DISPID__514_GET_NAME, DISPID__514_PUT_NAME, DISPID__520_GET_NAME, DISPID__520_PUT_NAME, DISPID__552_NAME, DISPID_1_NAME, DISPID_10_NAME, DISPID_11_GET_NAME, DISPID_11_PUT_NAME, DISPID_12_GET_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_PUTREF_NAME, DISPID_17_NAME, DISPID_18_GET_NAME, DISPID_19_NAME, DISPID_2_NAME, DISPID_20_GET_NAME, DISPID_21_GET_NAME, DISPID_22_GET_NAME, DISPID_22_PUT_NAME, DISPID_23_NAME, DISPID_24_GET_NAME, DISPID_25_GET_NAME, DISPID_26_GET_NAME, DISPID_27_GET_NAME, DISPID_28_GET_NAME, DISPID_29_GET_NAME, DISPID_3_NAME, DISPID_30_GET_NAME, DISPID_30_PUTREF_NAME, DISPID_31_GET_NAME, DISPID_32_GET_NAME, DISPID_33_GET_NAME, DISPID_33_PUT_NAME, DISPID_34_GET_NAME, DISPID_4_GET_NAME, DISPID_5_GET_NAME, DISPID_5_PUT_NAME, DISPID_6_NAME, DISPID_7_GET_NAME, DISPID_7_PUT_NAME, DISPID_8_NAME, DISPID_9_NAME, IID, IIDfeb9d62a_961d_4d44_a18f_90619837de03, xxDummy
 
Fields inherited from interface com.esri.arcgis.controls.IARGlobeControlDefault
DISPID__504_GET_NAME, DISPID__504_PUT_NAME, DISPID__514_GET_NAME, DISPID__514_PUT_NAME, DISPID__520_GET_NAME, DISPID__520_PUT_NAME, DISPID__552_NAME, DISPID_1_NAME, DISPID_10_NAME, DISPID_11_GET_NAME, DISPID_11_PUT_NAME, DISPID_12_GET_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_PUTREF_NAME, DISPID_17_NAME, DISPID_18_GET_NAME, DISPID_19_NAME, DISPID_2_NAME, DISPID_20_GET_NAME, DISPID_21_GET_NAME, DISPID_22_GET_NAME, DISPID_22_PUT_NAME, DISPID_23_NAME, DISPID_24_GET_NAME, DISPID_25_GET_NAME, DISPID_26_GET_NAME, DISPID_27_GET_NAME, DISPID_28_GET_NAME, DISPID_29_GET_NAME, DISPID_3_NAME, DISPID_30_GET_NAME, DISPID_30_PUTREF_NAME, DISPID_31_GET_NAME, DISPID_32_GET_NAME, DISPID_33_GET_NAME, DISPID_33_PUT_NAME, DISPID_34_GET_NAME, DISPID_4_GET_NAME, DISPID_5_GET_NAME, DISPID_5_PUT_NAME, DISPID_6_NAME, DISPID_7_GET_NAME, DISPID_7_PUT_NAME, DISPID_8_NAME, DISPID_9_NAME, IID, IID2e2916d1_7349_4d39_8dcb_3628167432ed, xxDummy
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
ArcReaderGlobeControl()
          Constructs a ArcReaderGlobeControl using ArcGIS Engine.
ArcReaderGlobeControl(java.lang.Object o)
          Constructs a ArcReaderGlobeControl.
 
Method Summary
 void aboutBox()
          Displays a dialog of information about the control.
 void addIARGlobeControlEventsListener(IARGlobeControlEvents theListener)
          addIARGlobeControlEventsListener.
 void addNotify()
           
 boolean checkDocument(java.lang.String sFilename)
          Checks the document filename to determine if its a valid Published Map File (*.PMF), published with permission to load into the control.
 void copyViewToClipboard()
          Copies the current map or page layout view to the clipboard.
 boolean equals(java.lang.Object o)
          Compare this object with another
 boolean esri_isEnabled()
          Indicates whether the control can respond to user generated events.
 void esri_setEnabled(boolean pbool)
          Indicates whether the control can respond to user generated events.
 void exportView(int format, java.lang.String sFilename)
          Exports the current view to a file.
 int getAppearance()
          The appearance of the control.
 IARConfiguration getARConfiguration()
          The ARConfiguration used by the control.
 IARGlobe getARGlobe()
          The ARGlobe container for the display of globe data.
 IARUnitConverter getARUnitConverter()
          The ARUnitConverter contained by the control.
 int getBorderStyle()
          The border style of the control.
static java.lang.String getClsid()
          getClsid.
 int getCurrentARGlobeTool()
          Current active tool for the control.
 int getCurrentGlobeViewType()
          The type of current globe view.
 java.lang.Object getCustomProperty()
          A property to associate data with a control.
 java.lang.String getDocumentComment()
          A comment about the currently loaded Published Map File (*.PMF).
 java.lang.String getDocumentFilename()
          The file name of the currently loaded Published Map File (*.PMF).
 int getHWnd()
          Handle to the window associated with the control.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 int getMousePointer()
          The mouse cursor displayed over the GlobeControl.
 java.lang.Object getObject()
          A property that returns the underlying Control.
 IARLayer getSelectedARLayer()
          The selected ARLayer in the TOC.
 int getShowGlobeTips()
          Indicates the type of tooltips shown on the Globe.
 IARLayer getSwipeLayer()
          The swipe layer used by the control.
 int getTOCWidth()
          The width of the Table of Contents (TOC) in pixels.
 int getViewHeight()
          The height of the Globe View in pixels.
 int getViewLeft()
          The number of pixels between the top of the control and the top of the Globe View.
 int getViewTop()
          The number of pixels between the left edge of the control and the left side of the Globe View.
 int getViewWidth()
          The width of the Globe View in pixels.
 int getViewWindow()
          Handle to the view window associated with the control.
 boolean hasDocumentPermission(int docPermission)
          Indicates if the currently loaded Published Map File (*.PMF) was published with the specified permission.
 boolean isARGlobeWindowVisible(int win)
          Indicates if the specified control window is visible.
 boolean isEnableFileDrop()
          Indicates whether Published Map Files can be dropped onto the control.
 boolean isHasCustomARConfiguration()
          Indicates whether the current PMF is using settings stored in the PMF.
 boolean isTOCVisible()
          Indicates if the Table of Contents (TOC) is visible.
 void loadDocument(java.lang.String sFilename, java.lang.String sPassword)
          Loads the Published Map File (*.PMF) into the control.
 void printView()
          Send the current map or page layout view to the printer.
 void refresh()
          Redraws the globe display area.
 void release()
          Release a ArcReaderGlobeControl.
 void reloadDocument(java.lang.String sPassword)
          Reloads the currently loaded Published Map File (*.PMF) back into the control.
 void removeIARGlobeControlEventsListener(IARGlobeControlEvents theListener)
          removeIARGlobeControlEventsListener.
 void setAppearance(int pappearance)
          The appearance of the control.
 void setARConfigurationByRef(IARConfiguration ppARConfiguration)
          The ARConfiguration used by the control.
 void setBorderStyle(int pstyle)
          The border style of the control.
 void setCurrentARGlobeTool(int pVal)
          Current active tool for the control.
 void setCustomProperty(java.lang.Object pVal)
          A property to associate data with a control.
 void setDocumentFilename(java.lang.String bsFilename)
          The file name of the currently loaded Published Map File (*.PMF).
 void setEnableFileDrop(boolean pvbValue)
          Indicates whether Published Map Files can be dropped onto the control.
 void setMousePointer(int pcursor)
          The mouse cursor displayed over the GlobeControl.
 void setShowGlobeTips(int esriARGlobeTips)
          Indicates the type of tooltips shown on the Globe.
 void setSwipeLayerByRef(IARLayer ppLayer)
          The swipe layer used by the control.
 void setTOCVisible(boolean visible)
          Indicates if the Table of Contents (TOC) is visible.
 void setTOCWidth(int lWidth)
          The width of the Table of Contents (TOC) in pixels.
 void showARGlobeWindow(int win, boolean show, java.lang.Object data)
          Shows or hides the specified control window.
 void unloadDocument()
          Unloads the currently loaded Published Map File (*.PMF) from the control.
 
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

ArcReaderGlobeControl

public ArcReaderGlobeControl()
Constructs a ArcReaderGlobeControl using ArcGIS Engine.


ArcReaderGlobeControl

public ArcReaderGlobeControl(java.lang.Object o)
Constructs a ArcReaderGlobeControl.

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

addIARGlobeControlEventsListener

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

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

removeIARGlobeControlEventsListener

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

Parameters:
theListener - An object that implements the com.esri.arcgis.controls.IARGlobeControlEvents 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 ArcReaderGlobeControl.

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

setBorderStyle

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

Specified by:
setBorderStyle in interface IARGlobeControl
Specified by:
setBorderStyle in interface IARGlobeControlDefault
Parameters:
pstyle - A com.esri.arcgis.controls.esriARBorderStyle 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 control.

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

esri_setEnabled

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

Specified by:
esri_setEnabled in interface IARGlobeControl
Specified by:
esri_setEnabled in interface IARGlobeControlDefault
Parameters:
pbool - The pbool (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

esri_isEnabled

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

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

setAppearance

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

Specified by:
setAppearance in interface IARGlobeControl
Specified by:
setAppearance in interface IARGlobeControlDefault
Parameters:
pappearance - A com.esri.arcgis.controls.esriARAppearance 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 control.

Specified by:
getAppearance in interface IARGlobeControl
Specified by:
getAppearance in interface IARGlobeControlDefault
Returns:
A com.esri.arcgis.controls.esriARAppearance constant
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 control.

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

loadDocument

public void loadDocument(java.lang.String sFilename,
                         java.lang.String sPassword)
                  throws java.io.IOException,
                         AutomationException
Loads the Published Map File (*.PMF) into the control.

Specified by:
loadDocument in interface IARGlobeControl
Specified by:
loadDocument in interface IARGlobeControlDefault
Parameters:
sFilename - The sFilename (in)
sPassword - The sPassword (in, optional, pass if not required)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

unloadDocument

public void unloadDocument()
                    throws java.io.IOException,
                           AutomationException
Unloads the currently loaded Published Map File (*.PMF) from the control.

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

reloadDocument

public void reloadDocument(java.lang.String sPassword)
                    throws java.io.IOException,
                           AutomationException
Reloads the currently loaded Published Map File (*.PMF) back into the control.

Specified by:
reloadDocument in interface IARGlobeControl
Specified by:
reloadDocument in interface IARGlobeControlDefault
Parameters:
sPassword - The sPassword (in, optional, pass if not required)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDocumentComment

public java.lang.String getDocumentComment()
                                    throws java.io.IOException,
                                           AutomationException
A comment about the currently loaded Published Map File (*.PMF).

Specified by:
getDocumentComment in interface IARGlobeControl
Specified by:
getDocumentComment in interface IARGlobeControlDefault
Returns:
The sComment
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 file name of the currently loaded Published Map File (*.PMF).

Specified by:
getDocumentFilename in interface IARGlobeControl
Specified by:
getDocumentFilename in interface IARGlobeControlDefault
Returns:
The bsFilename
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDocumentFilename

public void setDocumentFilename(java.lang.String bsFilename)
                         throws java.io.IOException,
                                AutomationException
The file name of the currently loaded Published Map File (*.PMF).

Specified by:
setDocumentFilename in interface IARGlobeControl
Specified by:
setDocumentFilename in interface IARGlobeControlDefault
Parameters:
bsFilename - The bsFilename (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

checkDocument

public boolean checkDocument(java.lang.String sFilename)
                      throws java.io.IOException,
                             AutomationException
Checks the document filename to determine if its a valid Published Map File (*.PMF), published with permission to load into the control.

Specified by:
checkDocument in interface IARGlobeControl
Specified by:
checkDocument in interface IARGlobeControlDefault
Parameters:
sFilename - The sFilename (in)
Returns:
The bIsOK
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTOCWidth

public void setTOCWidth(int lWidth)
                 throws java.io.IOException,
                        AutomationException
The width of the Table of Contents (TOC) in pixels.

Specified by:
setTOCWidth in interface IARGlobeControl
Specified by:
setTOCWidth in interface IARGlobeControlDefault
Parameters:
lWidth - The lWidth (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTOCWidth

public int getTOCWidth()
                throws java.io.IOException,
                       AutomationException
The width of the Table of Contents (TOC) in pixels.

Specified by:
getTOCWidth in interface IARGlobeControl
Specified by:
getTOCWidth in interface IARGlobeControlDefault
Returns:
The lWidth
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

printView

public void printView()
               throws java.io.IOException,
                      AutomationException
Send the current map or page layout view to the printer.

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

copyViewToClipboard

public void copyViewToClipboard()
                         throws java.io.IOException,
                                AutomationException
Copies the current map or page layout view to the clipboard.

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

exportView

public void exportView(int format,
                       java.lang.String sFilename)
                throws java.io.IOException,
                       AutomationException
Exports the current view to a file.

Specified by:
exportView in interface IARGlobeControl
Specified by:
exportView in interface IARGlobeControlDefault
Parameters:
format - A com.esri.arcgis.controls.esriARExportFormat constant (in)
sFilename - The sFilename (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTOCVisible

public void setTOCVisible(boolean visible)
                   throws java.io.IOException,
                          AutomationException
Indicates if the Table of Contents (TOC) is visible.

Specified by:
setTOCVisible in interface IARGlobeControl
Specified by:
setTOCVisible in interface IARGlobeControlDefault
Parameters:
visible - The visible (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isTOCVisible

public boolean isTOCVisible()
                     throws java.io.IOException,
                            AutomationException
Indicates if the Table of Contents (TOC) is visible.

Specified by:
isTOCVisible in interface IARGlobeControl
Specified by:
isTOCVisible in interface IARGlobeControlDefault
Returns:
The visible
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 control.

Specified by:
getHWnd in interface IARGlobeControl
Specified by:
getHWnd in interface IARGlobeControlDefault
Returns:
The window
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setShowGlobeTips

public void setShowGlobeTips(int esriARGlobeTips)
                      throws java.io.IOException,
                             AutomationException
Indicates the type of tooltips shown on the Globe.

Specified by:
setShowGlobeTips in interface IARGlobeControl
Specified by:
setShowGlobeTips in interface IARGlobeControlDefault
Parameters:
esriARGlobeTips - A com.esri.arcgis.controls.esriARGlobeTips 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 tooltips shown on the Globe.

Specified by:
getShowGlobeTips in interface IARGlobeControl
Specified by:
getShowGlobeTips in interface IARGlobeControlDefault
Returns:
A com.esri.arcgis.controls.esriARGlobeTips constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setEnableFileDrop

public void setEnableFileDrop(boolean pvbValue)
                       throws java.io.IOException,
                              AutomationException
Indicates whether Published Map Files can be dropped onto the control.

Specified by:
setEnableFileDrop in interface IARGlobeControl
Specified by:
setEnableFileDrop in interface IARGlobeControlDefault
Parameters:
pvbValue - The pvbValue (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isEnableFileDrop

public boolean isEnableFileDrop()
                         throws java.io.IOException,
                                AutomationException
Indicates whether Published Map Files can be dropped onto the control.

Specified by:
isEnableFileDrop in interface IARGlobeControl
Specified by:
isEnableFileDrop in interface IARGlobeControlDefault
Returns:
The pvbValue
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCurrentARGlobeTool

public int getCurrentARGlobeTool()
                          throws java.io.IOException,
                                 AutomationException
Current active tool for the control.

Specified by:
getCurrentARGlobeTool in interface IARGlobeControl
Specified by:
getCurrentARGlobeTool in interface IARGlobeControlDefault
Returns:
A com.esri.arcgis.controls.esriARGlobeTool constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCurrentARGlobeTool

public void setCurrentARGlobeTool(int pVal)
                           throws java.io.IOException,
                                  AutomationException
Current active tool for the control.

Specified by:
setCurrentARGlobeTool in interface IARGlobeControl
Specified by:
setCurrentARGlobeTool in interface IARGlobeControlDefault
Parameters:
pVal - A com.esri.arcgis.controls.esriARGlobeTool constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setARConfigurationByRef

public void setARConfigurationByRef(IARConfiguration ppARConfiguration)
                             throws java.io.IOException,
                                    AutomationException
The ARConfiguration used by the control.

Specified by:
setARConfigurationByRef in interface IARGlobeControl
Specified by:
setARConfigurationByRef in interface IARGlobeControlDefault
Parameters:
ppARConfiguration - A reference to a com.esri.arcgis.controls.IARConfiguration (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getARConfiguration

public IARConfiguration getARConfiguration()
                                    throws java.io.IOException,
                                           AutomationException
The ARConfiguration used by the control.

Specified by:
getARConfiguration in interface IARGlobeControl
Specified by:
getARConfiguration in interface IARGlobeControlDefault
Returns:
A reference to a com.esri.arcgis.controls.IARConfiguration
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

showARGlobeWindow

public void showARGlobeWindow(int win,
                              boolean show,
                              java.lang.Object data)
                       throws java.io.IOException,
                              AutomationException
Shows or hides the specified control window.

Specified by:
showARGlobeWindow in interface IARGlobeControl
Specified by:
showARGlobeWindow in interface IARGlobeControlDefault
Parameters:
win - A com.esri.arcgis.controls.esriARGlobeWindows constant (in)
show - The show (in, optional, pass true if not required)
data - A Variant (in, optional, pass null if not required)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isARGlobeWindowVisible

public boolean isARGlobeWindowVisible(int win)
                               throws java.io.IOException,
                                      AutomationException
Indicates if the specified control window is visible.

Specified by:
isARGlobeWindowVisible in interface IARGlobeControl
Specified by:
isARGlobeWindowVisible in interface IARGlobeControlDefault
Parameters:
win - A com.esri.arcgis.controls.esriARGlobeWindows constant (in)
Returns:
The visible
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

hasDocumentPermission

public boolean hasDocumentPermission(int docPermission)
                              throws java.io.IOException,
                                     AutomationException
Indicates if the currently loaded Published Map File (*.PMF) was published with the specified permission.

Specified by:
hasDocumentPermission in interface IARGlobeControl
Specified by:
hasDocumentPermission in interface IARGlobeControlDefault
Parameters:
docPermission - A com.esri.arcgis.controls.esriARDocumentPermissions constant (in)
Returns:
The hasPermission
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getARUnitConverter

public IARUnitConverter getARUnitConverter()
                                    throws java.io.IOException,
                                           AutomationException
The ARUnitConverter contained by the control.

Specified by:
getARUnitConverter in interface IARGlobeControl
Specified by:
getARUnitConverter in interface IARGlobeControlDefault
Returns:
A reference to a com.esri.arcgis.controls.IARUnitConverter
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.

Specified by:
getObject in interface IARGlobeControl
Specified by:
getObject in interface IARGlobeControlDefault
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.

getCustomProperty

public java.lang.Object getCustomProperty()
                                   throws java.io.IOException,
                                          AutomationException
A property to associate data with a control.

Specified by:
getCustomProperty in interface IARGlobeControl
Specified by:
getCustomProperty in interface IARGlobeControlDefault
Returns:
A Variant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCustomProperty

public void setCustomProperty(java.lang.Object pVal)
                       throws java.io.IOException,
                              AutomationException
A property to associate data with a control.

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

refresh

public void refresh()
             throws java.io.IOException,
                    AutomationException
Redraws the globe display area.

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

getARGlobe

public IARGlobe getARGlobe()
                    throws java.io.IOException,
                           AutomationException
The ARGlobe container for the display of globe data.

Specified by:
getARGlobe in interface IARGlobeControl
Specified by:
getARGlobe in interface IARGlobeControlDefault
Returns:
A reference to a com.esri.arcgis.controls.IARGlobe
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getViewTop

public int getViewTop()
               throws java.io.IOException,
                      AutomationException
The number of pixels between the left edge of the control and the left side of the Globe View.

Specified by:
getViewTop in interface IARGlobeControl
Specified by:
getViewTop in interface IARGlobeControlDefault
Returns:
The pVal
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getViewLeft

public int getViewLeft()
                throws java.io.IOException,
                       AutomationException
The number of pixels between the top of the control and the top of the Globe View.

Specified by:
getViewLeft in interface IARGlobeControl
Specified by:
getViewLeft in interface IARGlobeControlDefault
Returns:
The pVal
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getViewHeight

public int getViewHeight()
                  throws java.io.IOException,
                         AutomationException
The height of the Globe View in pixels.

Specified by:
getViewHeight in interface IARGlobeControl
Specified by:
getViewHeight in interface IARGlobeControlDefault
Returns:
The pVal
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getViewWidth

public int getViewWidth()
                 throws java.io.IOException,
                        AutomationException
The width of the Globe View in pixels.

Specified by:
getViewWidth in interface IARGlobeControl
Specified by:
getViewWidth in interface IARGlobeControlDefault
Returns:
The pVal
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isHasCustomARConfiguration

public boolean isHasCustomARConfiguration()
                                   throws java.io.IOException,
                                          AutomationException
Indicates whether the current PMF is using settings stored in the PMF.

Specified by:
isHasCustomARConfiguration in interface IARGlobeControl
Specified by:
isHasCustomARConfiguration in interface IARGlobeControlDefault
Returns:
The pVal
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSwipeLayerByRef

public void setSwipeLayerByRef(IARLayer ppLayer)
                        throws java.io.IOException,
                               AutomationException
The swipe layer used by the control.

Specified by:
setSwipeLayerByRef in interface IARGlobeControl
Specified by:
setSwipeLayerByRef in interface IARGlobeControlDefault
Parameters:
ppLayer - A reference to a com.esri.arcgis.controls.IARLayer (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSwipeLayer

public IARLayer getSwipeLayer()
                       throws java.io.IOException,
                              AutomationException
The swipe layer used by the control.

Specified by:
getSwipeLayer in interface IARGlobeControl
Specified by:
getSwipeLayer in interface IARGlobeControlDefault
Returns:
A reference to a com.esri.arcgis.controls.IARLayer
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getViewWindow

public int getViewWindow()
                  throws java.io.IOException,
                         AutomationException
Handle to the view window associated with the control.

Specified by:
getViewWindow in interface IARGlobeControl
Specified by:
getViewWindow in interface IARGlobeControlDefault
Returns:
The window
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCurrentGlobeViewType

public int getCurrentGlobeViewType()
                            throws java.io.IOException,
                                   AutomationException
The type of current globe view.

Specified by:
getCurrentGlobeViewType in interface IARGlobeControl
Specified by:
getCurrentGlobeViewType in interface IARGlobeControlDefault
Returns:
A com.esri.arcgis.controls.esriARGlobeViewType constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMousePointer

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

Specified by:
setMousePointer in interface IARGlobeControl
Specified by:
setMousePointer in interface IARGlobeControlDefault
Parameters:
pcursor - A com.esri.arcgis.controls.esriARMousePointer 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 cursor displayed over the GlobeControl.

Specified by:
getMousePointer in interface IARGlobeControl
Specified by:
getMousePointer in interface IARGlobeControlDefault
Returns:
A com.esri.arcgis.controls.esriARMousePointer constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSelectedARLayer

public IARLayer getSelectedARLayer()
                            throws java.io.IOException,
                                   AutomationException
The selected ARLayer in the TOC.

Specified by:
getSelectedARLayer in interface IARGlobeControl
Specified by:
getSelectedARLayer in interface IARGlobeControlDefault
Returns:
A reference to a com.esri.arcgis.controls.IARLayer
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.