com.esri.arcgis.controls
Class IARGlobeControlProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.controls.IARGlobeControlProxy

All Implemented Interfaces:

IARGlobeControl, Externalizable, Serializable

public class IARGlobeControlProxy
extends com.esri.arcgis.interop.Dispatch
implements IARGlobeControl, Serializable

Provides access to members on the control.

Description

The IARGlobeControl interface is a starting point for any tasks related to the ArcReaderGlobeControl. The interface is used to manipulate the ArcReaderGlobeControl object in a number of ways:

• checking and loading Published Map File (PMF) documents (*.pmf) into the ArcReaderGlobeControl.
• setting one of the built in tools to be the current tool used to interact with the ArcReaderGlobeControl, for example, the Identify tool.
• showing and hiding the built in windows contained within the ArcReaderGlobeControl, for example the Animation Window.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

See Also:

Serialized Form

Field Summary

boolean

noncastable

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

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	IARGlobeControlProxy()
	IARGlobeControlProxy(Object obj)
protected	IARGlobeControlProxy(Object obj, String iid)

Method Summary

void	aboutBox() Displays a dialog of information about the control.
void	addListener(String iidStr, Object theListener, Object theSource)
boolean	checkDocument(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	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, 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.
int	getCurrentARGlobeTool() Current active tool for the control.
int	getCurrentGlobeViewType() The type of current globe view.
Object	getCustomProperty() A property to associate data with a control.
String	getDocumentComment() A comment about the currently loaded Published Map File (*.PMF).
String	getDocumentFilename() The file name of the currently loaded Published Map File (*.PMF).
int	getHWnd() Handle to the window associated with the control.
int	getMousePointer() The mouse cursor displayed over the GlobeControl.
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(String sFilename, 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	reloadDocument(String sPassword) Reloads the currently loaded Published Map File (*.PMF) back into the control.
void	removeListener(String iidStr, Object theListener)
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(Object pVal) A property to associate data with a control.
void	setDocumentFilename(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, 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.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

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

Field Detail

noncastable

public boolean noncastable

Constructor Detail

IARGlobeControlProxy

public IARGlobeControlProxy()

IARGlobeControlProxy

public IARGlobeControlProxy(Object obj)
                     throws IOException

Throws:

IOException

IARGlobeControlProxy

protected IARGlobeControlProxy(Object obj,
                               String iid)
                        throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

setBorderStyle

public void setBorderStyle(int pstyle)
                    throws IOException,
                           AutomationException

The border style of the control.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

setBorderStyle in interface IARGlobeControl

Parameters:

pstyle - A com.esri.arcgis.controls.esriARBorderStyle constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBorderStyle

public int getBorderStyle()
                   throws IOException,
                          AutomationException

The border style of the control.

Description

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

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getBorderStyle in interface IARGlobeControl

Returns:

A com.esri.arcgis.controls.esriARBorderStyle constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_setEnabled

public void esri_setEnabled(boolean pbool)
                     throws IOException,
                            AutomationException

Indicates whether the control can respond to user generated events.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

esri_setEnabled in interface IARGlobeControl

Parameters:

pbool - The pbool (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_isEnabled

public boolean esri_isEnabled()
                       throws IOException,
                              AutomationException

Indicates whether the control can respond to user generated events.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

esri_isEnabled in interface IARGlobeControl

Returns:

The pbool

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAppearance

public void setAppearance(int pappearance)
                   throws IOException,
                          AutomationException

The appearance of the control.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

setAppearance in interface IARGlobeControl

Parameters:

pappearance - A com.esri.arcgis.controls.esriARAppearance constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAppearance

public int getAppearance()
                  throws IOException,
                         AutomationException

The appearance of the control.

Description

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

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getAppearance in interface IARGlobeControl

Returns:

A com.esri.arcgis.controls.esriARAppearance constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

aboutBox

public void aboutBox()
              throws IOException,
                     AutomationException

Displays a dialog of information about the control.

Description

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

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

aboutBox in interface IARGlobeControl

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

loadDocument

public void loadDocument(String sFilename,
                         String sPassword)
                  throws IOException,
                         AutomationException

Loads the Published Map File (*.PMF) into the control.

Description

Loads the specified Published Map File (*.pmf) into the ArcReaderGlobeControl. Use the CheckDocument method to determine if the specified Published Map File can be loaded successfully.

If a document was password protected when it was published and the password is not passed within the LoadDocument method, the user will be prompted automatically for a password. If an incorrect password is supplied twice in succession a custom error will be returned.

If a document is successfully loaded the CurrentARGlobeTool will be set. The default CurrentARGlobeTool is specified by the ‘DefaultGlobeTool’ setting in the ARConfiguration. The DocumentFilename property will update itself with the path and filename of the currently loaded document, and the DocumentComment property to update itself with any comments that were supplied by the publisher of the document.

Remarks

The LoadDocument method triggers the following events:

OnDocumentLoad

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

loadDocument in interface IARGlobeControl

Parameters:

sFilename - The sFilename (in)

sPassword - The sPassword (in, optional, pass if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

unloadDocument

public void unloadDocument()
                    throws IOException,
                           AutomationException

Unloads the currently loaded Published Map File (*.PMF) from the control.

Description

The UnloadDocument method removes the currently loaded PMF document from the ArcReaderGlobeControl and causes the DocumentFilename property to update itself with an empty string. At this point the ArcReaderGlobeControl is empty.

Remarks

The UnloadDocument method triggers the following events:

OnDocumentUnloaded

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

unloadDocument in interface IARGlobeControl

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

reloadDocument

public void reloadDocument(String sPassword)
                    throws IOException,
                           AutomationException

Reloads the currently loaded Published Map File (*.PMF) back into the control.

Description

The ReloadDocument method loads the currently loaded Published Map File back into the ArcReaderGlobeControl. This resets the ArcReaderGlobeControl to the state of the Published Map File on disk, resetting the view, the extent of the view and layer visibility.

If a document was password protected when it was published and the password is not passed within the LoadDocument method, the user will be prompted automatically for a password. If an incorrect password is supplied twice in succession a custom error will be returned.

Remarks

The ReloadDocument method triggers the following events:

OnDocumentUnloaded
OnDocumentLoaded

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

reloadDocument in interface IARGlobeControl

Parameters:

sPassword - The sPassword (in, optional, pass if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDocumentComment

public String getDocumentComment()
                          throws IOException,
                                 AutomationException

A comment about the currently loaded Published Map File (*.PMF).

Description

Returns any comments that were specified when the currently loaded document was published.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getDocumentComment in interface IARGlobeControl

Returns:

The sComment

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDocumentFilename

public String getDocumentFilename()
                           throws IOException,
                                  AutomationException

The file name of the currently loaded Published Map File (*.PMF).

Description

Returns the file name of the currently loaded document.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getDocumentFilename in interface IARGlobeControl

Returns:

The bsFilename

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDocumentFilename

public void setDocumentFilename(String bsFilename)
                         throws IOException,
                                AutomationException

The file name of the currently loaded Published Map File (*.PMF).

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

setDocumentFilename in interface IARGlobeControl

Parameters:

bsFilename - The bsFilename (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

checkDocument

public boolean checkDocument(String sFilename)
                      throws IOException,
                             AutomationException

Checks the document filename to determine if its a valid Published Map File (*.PMF), published with permission to load into the control.

Description

Determines whether the specified Published Map File (*.pmf) is a valid file and was published with permission to load into the ArcReaderGlobeControl.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

checkDocument in interface IARGlobeControl

Parameters:

sFilename - The sFilename (in)

Returns:

The bIsOK

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTOCWidth

public void setTOCWidth(int lWidth)
                 throws IOException,
                        AutomationException

The width of the Table of Contents (TOC) in pixels.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

setTOCWidth in interface IARGlobeControl

Parameters:

lWidth - The lWidth (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTOCWidth

public int getTOCWidth()
                throws IOException,
                       AutomationException

The width of the Table of Contents (TOC) in pixels.

Description

The width of the Table of Contents (TOC) in pixels. By default the TOCWidth property is set to 180. The minimum value that can be set to the TOCWidth property is 4.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getTOCWidth in interface IARGlobeControl

Returns:

The lWidth

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

printView

public void printView()
               throws IOException,
                      AutomationException

Send the current map or page layout view to the printer.

Description

Sends the view to either the system default printer or the last printer selected in either the esriARGlobeWindowsPageSetup or esriARGlobeWindowsPrinter window.

Remarks

The PrintView method will return an error if the currently loaded document was not published with permission to Print. Use the IARGlobeControl::HasDocumentPermission method to determine this.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

printView in interface IARGlobeControl

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

copyViewToClipboard

public void copyViewToClipboard()
                         throws IOException,
                                AutomationException

Copies the current map or page layout view to the clipboard.

Description

Copies a bitmap of the view to the system clipboard so that it can be copied into other applications. The output will exactly reflect the state of the view as seen on the screen.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

copyViewToClipboard in interface IARGlobeControl

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

exportView

public void exportView(int format,
                       String sFilename)
                throws IOException,
                       AutomationException

Exports the current view to a file.

Description

Export the current view of the globe to a bitmap file.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

exportView in interface IARGlobeControl

Parameters:

format - A com.esri.arcgis.controls.esriARExportFormat constant (in)

sFilename - The sFilename (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTOCVisible

public void setTOCVisible(boolean visible)
                   throws IOException,
                          AutomationException

Indicates if the Table of Contents (TOC) is visible.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

setTOCVisible in interface IARGlobeControl

Parameters:

visible - The visible (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isTOCVisible

public boolean isTOCVisible()
                     throws IOException,
                            AutomationException

Indicates if the Table of Contents (TOC) is visible.

Description

Indicates if the Table of Contents (TOC) is visible.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

isTOCVisible in interface IARGlobeControl

Returns:

The visible

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHWnd

public int getHWnd()
            throws IOException,
                   AutomationException

Handle to the window associated with the control.

Description

The operating environment identifies each window, form and control in an application by assigning it a handle, or hWnd.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getHWnd in interface IARGlobeControl

Returns:

The window

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowGlobeTips

public void setShowGlobeTips(int esriARGlobeTips)
                      throws IOException,
                             AutomationException

Indicates the type of tooltips shown on the Globe.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

setShowGlobeTips in interface IARGlobeControl

Parameters:

esriARGlobeTips - A com.esri.arcgis.controls.esriARGlobeTips constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getShowGlobeTips

public int getShowGlobeTips()
                     throws IOException,
                            AutomationException

Indicates the type of tooltips shown on the Globe.

Description

Determines whether globe tips are displayed (if they exist) as the mouse moves over layer features. Globe tips will be present if they were present in the ArcGlobe document at the time of publishing. By default the ShowGlobeTips property is set to true.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getShowGlobeTips in interface IARGlobeControl

Returns:

A com.esri.arcgis.controls.esriARGlobeTips constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEnableFileDrop

public void setEnableFileDrop(boolean pvbValue)
                       throws IOException,
                              AutomationException

Indicates whether Published Map Files can be dropped onto the control.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

setEnableFileDrop in interface IARGlobeControl

Parameters:

pvbValue - The pvbValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEnableFileDrop

public boolean isEnableFileDrop()
                         throws IOException,
                                AutomationException

Indicates whether Published Map Files can be dropped onto the control.

Description

Indicates if the ArcReaderGlobeControl will load Published Map Files (*.pmf) by the user interactively dropping files onto the ArcReaderGlobeControl from other applications such as ArcCatalog or Windows Explorer. The ArcReaderGlobeControl itself will determine if the file that has been dropped is a PMF document that can be loaded into the ArcReaderGlobeControl.

By default dragging a file over the ArcReaderGlobeControl will cause the mouse cursor to change to an ‘add data’ cursor. Setting the EnableFileDrop property to False, will cause the mouse cursor to change to a ‘no entry’ cursor when files are dragged over the ArcReaderGlobeControl.

If a document is successfully loaded the CurrentARGlobeTool will be set. The default CurrentARGlobeTool is specified by the ‘DefaultGlobeTool’ setting in the ARConfiguration. The DocumentFilename property will update itself with the path and filename of the currently loaded document, and the DocumentComment property to update itself with any comments that were supplied by the publisher of the document.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

isEnableFileDrop in interface IARGlobeControl

Returns:

The pvbValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentARGlobeTool

public int getCurrentARGlobeTool()
                          throws IOException,
                                 AutomationException

Current active tool for the control.

Description

The CurrentTool used to interact with the ARGlobe. Setting the CurrentARGlobeTool will change the mouse cursor and may popup a modeless dialog. For example, setting the current tool to the built in identify tool will cause the identify dialog to open. The CurrentARGlobeTool cannot be set to Nothing, instead set the CurrentARGlobeTool to the NoneSelected tool.

Tool	Description
esriARGlobeToolNoneSelected	Use this tool if you want nothing to happen when the user interacts with the ARGlobe.
esriARGlobeToolNavigate	Use this tool to navigate the ARGlobe. Activating the tool will set ARGlobe::Pitch = 0. Using the left mouse button the tool allows the user to rotate the globe about its center. Using the right mouse button the tool allows the user to zoom in and out along an imaginary straight line from the observer location to the ARGlobe center.
esriARGlobeToolTarget	Use this tool to center a location, on the ARGlobe surface, in the view.
esriARGlobeToolZoomInOut	Use this tool to Zoom In and Zoom Out along an imaginary straight line between the observer location and the target on the ARGlobe surface.
esriARGlobeToolPan	Use this tool to pan the ARGlobe surface. Depress the mouse and drag the view in a particular direction, before releasing the mouse, to pan.
esriARGlobeToolPivot	Use this tool to view the point on the ARGlobe surface that is centered in the view. Using the left mouse button the tool allows the user to pivot about a point on the ARGlobe surface that is located at the center of the view. Using the right mouse button the tool allows the user to Zoom In and Zoom Out along an imaginary straight line between the observer location and the center of the view. Activating this tool will set the ARGlobe::Pitch to a none zero value.
esriARGlobeToolIdentify, esriARGlobeToolIdentifyUsingLayer	Use these tools to identify features in the ARGlobe. Click on a single feature to view its attribute information. The window has its own context menus; incorporates a raster viewer; and can display hyperlinks.
esriARGlobeToolMeasure	Use this tool to measure distances on the ARGlobe. Measurements are given in IARGlobe::GlobeUnits.
esriARGlobeToolSwipe	Use this tool to view the layer beneath the ArcReaderGlobeControl::SwipeLayer.
esriARGlobeToolHyperlink	Use this tool to access any hyperlinks present in the data.
esriARGlobeToolOrbitalFly	Use this tool to fly over the ARGlobe surface at a fixed elevation. Activating this tool will display a dialog with buttons that allow a user to control flight. The dialog will be displayed within the ArcReaderGlobeControl, as specified by the window position property, accessed via the ArcReaderGlobeControl property pages.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getCurrentARGlobeTool in interface IARGlobeControl

Returns:

A com.esri.arcgis.controls.esriARGlobeTool constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCurrentARGlobeTool

public void setCurrentARGlobeTool(int pVal)
                           throws IOException,
                                  AutomationException

Current active tool for the control.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

setCurrentARGlobeTool in interface IARGlobeControl

Parameters:

pVal - A com.esri.arcgis.controls.esriARGlobeTool constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setARConfigurationByRef

public void setARConfigurationByRef(IARConfiguration ppARConfiguration)
                             throws IOException,
                                    AutomationException

The ARConfiguration used by the control.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

setARConfigurationByRef in interface IARGlobeControl

Parameters:

ppARConfiguration - A reference to a com.esri.arcgis.controls.IARConfiguration (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getARConfiguration

public IARConfiguration getARConfiguration()
                                    throws IOException,
                                           AutomationException

The ARConfiguration used by the control.

Description

This is the ARConfiguration object contained within the ArcReaderGlobeControl. It is a helper object for customising the appearance and behaviour of the ArcReaderGlobeControl. It consists of many property and value settings that are stored in a template file (.art), known as an ‘ArcReader Template’.

There are various ways to manage these property and value settings:

• At design time using the ArcReaderGlobeControl property pages.
• Using the ArcReader Configuration developer tool.
• Programmatically using the ARConfiguration object.

In order for the ArcReaderGlobeControl to update itself to match any updated settings the ARConfiguration object must be set back into the ArcReaderGlobeControl.

The ArcReaderGlobeControl will initially look for an template file in a users local profile. If no template file is found a default configuration file will be created containing default settings. The contents of the ARConfiguration can be stored in a template file in the current user profile and used as an initialization or "INI" file. The ArcReader desktop application does this using a
file called ArcReader.art. It is recommended not to reuse this file as it may break the ArcReader desktop application. Instead, use a location such as:

User profile\Application Data\CompanyName\ProductName\Templates\FileName.art

Once a template has been saved it can be loaded into the ArcReaderGlobeControl to suit a particular user or application. For example, a user may have a preference about the window position of the magnifier window and whether the table of contents is displayed. When the ArcReaderGlobeControl exits (typically when the form or container is closed) the value of these settings is updated back into the ARConfiguration. Additional custom settings can be added to the ARConfiguration, to store user preferences specific to the custom application.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getARConfiguration in interface IARGlobeControl

Returns:

A reference to a com.esri.arcgis.controls.IARConfiguration

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

showARGlobeWindow

public void showARGlobeWindow(int win,
                              boolean show,
                              Object data)
                       throws IOException,
                              AutomationException

Shows or hides the specified control window.

Description

The ShowARGlobeWindow shows or hides the specified built in window. By default all of the esriARGlobeWindows are closed. Before using the ShowARGlobeWindow method make one or all of the following checks:

• check that the current document was published with permission to open a particular window using the HasDocumentPermission method.
• if closing a modeless window check that is actually open using the ARGlobeWindowVisible property.

A modal window requires a response from the user, before they can interact with another part of the application. A modeless window will stay on the screen, available for use, but allow the user to interact with other parts of the application. When the LoadDocument or ReloadDocument methods are used, any modeless windows will be automatically closed.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

showARGlobeWindow in interface IARGlobeControl

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isARGlobeWindowVisible

public boolean isARGlobeWindowVisible(int win)
                               throws IOException,
                                      AutomationException

Indicates if the specified control window is visible.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

isARGlobeWindowVisible in interface IARGlobeControl

Parameters:

win - A com.esri.arcgis.controls.esriARGlobeWindows constant (in)

Returns:

The visible

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

hasDocumentPermission

public boolean hasDocumentPermission(int docPermission)
                              throws IOException,
                                     AutomationException

Indicates if the currently loaded Published Map File (*.PMF) was published with the specified permission.

Description

The HasDocumentPermission method determines whether the currently loaded document was published with the specified functionality permission.

When a document is published the publisher can set a variety of permissions to limit the functionality that a user has access to when viewing the document in the ArcReaderGlobeControl. These permissions should be checked and the behavior of an application modified appropriately. For example, if permission to access hyperlinks does not exist an application should be modified so that a user can not set the current tool to the hyperlink tool.

Remarks

esriARDocumentPermissionsPrint: Indicates whether permission exists to use the PrintView method and the ShowARWindow method to open the PageSetup and Printer windows.

esriARDocumentPermissionsExport: Indicates whether permission exists to use the IARGlobeControl::ExportView method.

esriARDocumentPermissionsIdentify: Indicates whether permission exists to set the CurrentARTool property to the Identify tool to use the ShowARWindow method to open the Identify window.

esriARDocumentPermissionsFind: Indicates whether permission exists to use the ShowARWindow method to open the Find window.

esriARDocumentPermissionsChangeView: This does not apply to the ArcReaderGlobeControl.

esriARDocumentPermissionsChangeLayerVisibility: Indicates whether permission exists to set the IARLayer::Visible property.

esriARDocumentPermissionsHyperlink: Indicates whether permission exists to set the CurrentARTool property to the Hyperlinks tool.

esriARDocumentPermissionsMeasure: Indicates whether permission exists to set the CurrentARTool property to the Measure tool.

esriARDocumentPermissionsViewTOC: Indicates whether permission exists to set the TOCVisible property.

esriARDocumentPermissionsOnlyInArcReader: This does not apply to the ArcReaderGlobeControl.

esriARDocumentPermissionsQueryFeatures: Indicates whether permission exists to use the IARGlobe::SearchARFeatures, IARGlobe::QueryARFeatures, IARLayer::SearchARFeatures, and IARLayer::QueryARFeatures methods.

esriARDocumentPermissionsQueryValues: Indicates whether permission exists to use the IARFeature::Value property.

esriARDocumentPermissionsCopyViewToClipboard: Indicates whether permission exists to use the CopyViewToClipboard method.

esriARDocumentPermissionsInternalObjects: This does not apply to the ArcReaderGlobeControl.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

hasDocumentPermission in interface IARGlobeControl

Parameters:

docPermission - A com.esri.arcgis.controls.esriARDocumentPermissions constant (in)

Returns:

The hasPermission

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getARUnitConverter

public IARUnitConverter getARUnitConverter()
                                    throws IOException,
                                           AutomationException

The ARUnitConverter contained by the control.

Description

The ARUnitConverter object is a helper object for firstly converting values between different esriARUnits and secondly for converting values and esriARUnits constants to strings.

Remarks

Caution should be exercised, when converting units of measurement, that the conversion is sensible. For example, the ARUnitConverter will allow one to convert a distance measured in Kilometers to a distance in Decimal Degrees. However, because the meridians converge towards the poles, a degree of longitude varies in size. One degree of longitude is approximately 111km at the equator but only 79km at a latitude of 45 degrees. The ARUnitConverter has no in-built intelligence to handle such conversions but does allow such conversions to be undertaken. If the ARUnitConverter is used to convert a distance of 1 decimal degree to kilometres, it assumes the distance is a measure of latitude, or a measure of longitude at the equator.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getARUnitConverter in interface IARGlobeControl

Returns:

A reference to a com.esri.arcgis.controls.IARUnitConverter

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getObject

public Object getObject()
                 throws IOException,
                        AutomationException

A property that returns the underlying Control.

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.

When querying interface to IARGlobeControl in Visual Basic 6.0 the Object property must be used. This is because Visual Basic 6.0 contains the real control inside a wrapper object known as an extender object.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getObject in interface IARGlobeControl

Returns:

A reference to another Automation Object (IDispatch)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCustomProperty

public Object getCustomProperty()
                         throws IOException,
                                AutomationException

A property to associate data with a control.

Description

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

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getCustomProperty in interface IARGlobeControl

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCustomProperty

public void setCustomProperty(Object pVal)
                       throws IOException,
                              AutomationException

A property to associate data with a control.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

setCustomProperty in interface IARGlobeControl

Parameters:

pVal - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

refresh

public void refresh()
             throws IOException,
                    AutomationException

Redraws the globe display area.

Description

The Refresh method causes screen display area of the current view to be redrawn by sending a windows paint event.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

refresh in interface IARGlobeControl

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getARGlobe

public IARGlobe getARGlobe()
                    throws IOException,
                           AutomationException

The ARGlobe container for the display of globe data.

Description

Returns the ARGlobe. The ARGlobe represents the globe contained within the Published Map document. A document can contain only one ARGlobe.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getARGlobe in interface IARGlobeControl

Returns:

A reference to a com.esri.arcgis.controls.IARGlobe

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getViewTop

public int getViewTop()
               throws IOException,
                      AutomationException

The number of pixels between the left edge of the control and the left side of the Globe View.

Description

The top of the current view display area in pixels. This will always return 0.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getViewTop in interface IARGlobeControl

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getViewLeft

public int getViewLeft()
                throws IOException,
                       AutomationException

The number of pixels between the top of the control and the top of the Globe View.

Description

The left side of the current view display area in pixels. The ViewLeft is equal to the TOCWidth + 4 (the width of the splitter that separates the TOC from the current view display area).

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getViewLeft in interface IARGlobeControl

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getViewHeight

public int getViewHeight()
                  throws IOException,
                         AutomationException

The height of the Globe View in pixels.

Description

The height of the current view display area in pixels.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getViewHeight in interface IARGlobeControl

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getViewWidth

public int getViewWidth()
                 throws IOException,
                        AutomationException

The width of the Globe View in pixels.

Description

The width of the current view display area in pixels. The ViewWidth is equal to the width of the ArcReaderGlobeControl - TOCWidth - 4 (the width of the splitter that separates the TOC from the current view display area).

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getViewWidth in interface IARGlobeControl

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHasCustomARConfiguration

public boolean isHasCustomARConfiguration()
                                   throws IOException,
                                          AutomationException

Indicates whether the current PMF is using settings stored in the PMF.

Description

This property can be used to determine if the currently loaded document has been published with an embedded ArcReader Template File (ART).

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

isHasCustomARConfiguration in interface IARGlobeControl

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSwipeLayerByRef

public void setSwipeLayerByRef(IARLayer ppLayer)
                        throws IOException,
                               AutomationException

The swipe layer used by the control.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

setSwipeLayerByRef in interface IARGlobeControl

Parameters:

ppLayer - A reference to a com.esri.arcgis.controls.IARLayer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSwipeLayer

public IARLayer getSwipeLayer()
                       throws IOException,
                              AutomationException

The swipe layer used by the control.

Description

This property can be used to specify the ARLayer which is used by the esriARToolGlobeSwipe. Layers beneath the ArcReaderGlobeControl::SwipeLayer will be revealed when the esriARToolGlobeSwipe tool is used.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getSwipeLayer in interface IARGlobeControl

Returns:

A reference to a com.esri.arcgis.controls.IARLayer

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getViewWindow

public int getViewWindow()
                  throws IOException,
                         AutomationException

Handle to the view window associated with the control.

Description

The operating environment identifies each window, form and control in an application by assigning it a handle, or hWnd. The ArcReaderGlobeControl is composed of several windows, this property returns the hWnd of the window containing the current view.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getViewWindow in interface IARGlobeControl

Returns:

The window

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentGlobeViewType

public int getCurrentGlobeViewType()
                            throws IOException,
                                   AutomationException

The type of current globe view.

Description

Returns the type of current view. If no document has been loaded esriARGlobeViewTypeNone will be returned. If a document has been loaded esriARGlobeViewTypeGlobe will be returned.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getCurrentGlobeViewType in interface IARGlobeControl

Returns:

A com.esri.arcgis.controls.esriARGlobeViewType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMousePointer

public void setMousePointer(int pcursor)
                     throws IOException,
                            AutomationException

The mouse cursor displayed over the GlobeControl.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

setMousePointer in interface IARGlobeControl

Parameters:

pcursor - A com.esri.arcgis.controls.esriARMousePointer constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMousePointer

public int getMousePointer()
                    throws IOException,
                           AutomationException

The mouse cursor displayed over the GlobeControl.

Description

You can use MousePointer property to set the ARGlobe mouse pointer to be one of the built-in esriARMousePointers. This is useful if you want to display a wait cursor while you code performs a large process. The specified esriARMousePointer is displayed provided the ArcReaderGlobeControl::CurrentARTool is set to esriARToolNoneSelected.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getMousePointer in interface IARGlobeControl

Returns:

A com.esri.arcgis.controls.esriARMousePointer constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSelectedARLayer

public IARLayer getSelectedARLayer()
                            throws IOException,
                                   AutomationException

The selected ARLayer in the TOC.

Description

Returns the ARLayer that has been selected in the Table Of Contents (TOC). If no layer has been selected in the TOC, this method will return nothing. For example, this property could be used to restrict a spatial search to the extent of the selected layer in the TOC.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:

getSelectedARLayer in interface IARGlobeControl

Returns:

A reference to a com.esri.arcgis.controls.IARLayer

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.