com.esri.arcgis.controls
Class IARControlDefaultProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.controls.IARControlDefaultProxy
All Implemented Interfaces:
IARControlDefault, java.io.Externalizable, java.io.Serializable

public class IARControlDefaultProxy
extends com.esri.arcgis.interop.Dispatch
implements IARControlDefault, java.io.Serializable

Internal use class Proxy for COM Interface 'IARControlDefault'. Generated 3/19/2015 1:21:02 PM from 'C:\ArcGIS\COM\esriPublisherControls.olb'

Description: 'Provides access to members on the control.' 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

Field Summary
 boolean noncastable
           
static java.lang.Class targetClass
           
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef
 
Fields inherited from interface com.esri.arcgis.controls.IARControlDefault
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_GET_NAME, DISPID_10_PUT_NAME, DISPID_11_NAME, DISPID_12_NAME, DISPID_13_GET_NAME, DISPID_13_PUT_NAME, DISPID_14_NAME, DISPID_15_GET_NAME, DISPID_15_PUT_NAME, DISPID_16_GET_NAME, DISPID_16_PUT_NAME, DISPID_17_GET_NAME, DISPID_18_GET_NAME, DISPID_18_PUT_NAME, DISPID_19_NAME, DISPID_2_NAME, DISPID_20_GET_NAME, DISPID_21_GET_NAME, DISPID_21_PUTREF_NAME, DISPID_22_GET_NAME, DISPID_23_GET_NAME, DISPID_23_PUT_NAME, DISPID_24_NAME, DISPID_25_GET_NAME, DISPID_26_NAME, DISPID_27_GET_NAME, DISPID_27_PUT_NAME, DISPID_28_GET_NAME, DISPID_28_PUT_NAME, DISPID_29_GET_NAME, DISPID_3_NAME, DISPID_30_GET_NAME, DISPID_31_GET_NAME, DISPID_32_GET_NAME, DISPID_33_GET_NAME, DISPID_34_GET_NAME, DISPID_35_GET_NAME, DISPID_35_PUTREF_NAME, DISPID_36_GET_NAME, DISPID_37_GET_NAME, DISPID_37_PUT_NAME, DISPID_38_GET_NAME, DISPID_4_GET_NAME, DISPID_4_PUTREF_NAME, DISPID_5_GET_NAME, DISPID_6_GET_NAME, DISPID_7_NAME, DISPID_8_GET_NAME, DISPID_9_NAME, IID, IIDa9a61e12_928c_44fb_a150_a5480c72c7f4
 
Constructor Summary
  IARControlDefaultProxy()
          For internal use only
  IARControlDefaultProxy(java.lang.Object obj)
           
protected IARControlDefaultProxy(java.lang.Object obj, java.lang.String iid)
           
  IARControlDefaultProxy(java.lang.String CLSID, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
           
protected IARControlDefaultProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
           
 
Method Summary
 void aboutBox()
          Displays a dialog of information about the control.
 void addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource)
           
 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 esri_isEnabled()
          Indicates whether the control can respond to user generated events.
 void esri_setEnabled(boolean rhs1)
          Indicates whether the control can respond to user generated events.
 void exportView(int format, java.lang.String sFilename)
          Export the current map or page layout view to the file.
 int getAppearance()
          The appearance of the control.
 IARCommandInfo getARCommandInfo(int tool)
          The ARCommandInfo contained by the control.
 IARConfiguration getARConfiguration()
          The ARConfiguration used by the control.
 IARPageLayout getARPageLayout()
          The page layout contained within the currently loaded document.
 IARUnitConverter getARUnitConverter()
          The ARUnitConverter contained by the control.
 int getBorderStyle()
          The border style of the control.
 int getCurrentARTool()
          Current active tool for the control.
 java.lang.Object getCurrentView()
          The current map or page layout view.
 int getCurrentViewType()
          The type of current 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.
 int getMousePointer()
          The mouse cursor displayed over the document.
 java.lang.Object getObject()
          A property that returns the underlying control.
 IARLayer getSelectedARLayer()
          The selected ARLayer in the TOC.
 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 Active View in pixels.
 int getViewLeft()
          The number of pixels between the top of the control and the top of the Active View.
 int getViewTop()
          The number of pixels between the left edge of the control and the left side of the Active View.
 int getViewWidth()
          The width of the Active 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 isARWindowVisible(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()
          Is the current PMF using settings stored in the PMF.
 boolean isShowMapTips()
          Indicates if map tips are shown when the current view is a map or page layout.
 boolean isShowScrollbars(int viewType)
          Indicates if the map and page layout scrollbars are visible.
 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(boolean refreshNow)
          Refresh the control's window.
 void reloadDocument(java.lang.String sPassword)
          Reloads the currently loaded Published Map File (*.PMF) back into the control.
 void removeListener(java.lang.String iidStr, java.lang.Object theListener)
           
 void setAppearance(int rhs1)
          The appearance of the control.
 void setARConfigurationByRef(IARConfiguration rhs1)
          The ARConfiguration used by the control.
 void setBorderStyle(int rhs1)
          The border style of the control.
 void setCurrentARTool(int rhs1)
          Current active tool for the control.
 void setCurrentViewByRef(java.lang.Object rhs1)
          The current map or page layout view.
 void setCustomProperty(java.lang.Object rhs1)
          A property to associate data with a control.
 void setDocumentFilename(java.lang.String rhs1)
          The file name of the currently loaded Published Map File (*.PMF).
 void setEnableFileDrop(boolean rhs1)
          Indicates whether Published Map Files can be dropped onto the control.
 void setMousePointer(int rhs1)
          The mouse cursor displayed over the document.
 void setShowMapTips(boolean rhs1)
          Indicates if map tips are shown when the current view is a map or page layout.
 void setShowScrollbars(int viewType, boolean rhs2)
          Indicates if the map and page layout scrollbars are visible.
 void setSwipeLayerByRef(IARLayer rhs1)
          The swipe layer used by the control.
 void setTOCVisible(boolean rhs1)
          Indicates if the Table of Contents (TOC) is visible.
 void setTOCWidth(int rhs1)
          The width of the Table of Contents (TOC) in pixels.
 void showARWindow(int win, boolean show, java.lang.Object data)
          Shows or hides the specified control window.
 void suppressResizeDrawing(boolean suppressResize, int resizeHWnd)
          Suppress full redraw of control during resize operations.
 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

targetClass

public static final java.lang.Class targetClass

noncastable

public boolean noncastable
Constructor Detail

IARControlDefaultProxy

public IARControlDefaultProxy(java.lang.String CLSID,
                              java.lang.String host,
                              com.esri.arcgis.interop.AuthInfo authInfo)
                       throws java.net.UnknownHostException,
                              java.io.IOException
Throws:
java.net.UnknownHostException
java.io.IOException

IARControlDefaultProxy

public IARControlDefaultProxy()
For internal use only


IARControlDefaultProxy

public IARControlDefaultProxy(java.lang.Object obj)
                       throws java.io.IOException
Throws:
java.io.IOException

IARControlDefaultProxy

protected IARControlDefaultProxy(java.lang.Object obj,
                                 java.lang.String iid)
                          throws java.io.IOException
Throws:
java.io.IOException

IARControlDefaultProxy

protected IARControlDefaultProxy(java.lang.String CLSID,
                                 java.lang.String iid,
                                 java.lang.String host,
                                 com.esri.arcgis.interop.AuthInfo authInfo)
                          throws java.io.IOException
Throws:
java.io.IOException
Method Detail

addListener

public void addListener(java.lang.String iidStr,
                        java.lang.Object theListener,
                        java.lang.Object theSource)
                 throws java.io.IOException
Overrides:
addListener in class com.esri.arcgis.interop.Dispatch
Throws:
java.io.IOException

removeListener

public void removeListener(java.lang.String iidStr,
                           java.lang.Object theListener)
                    throws java.io.IOException
Overrides:
removeListener in class com.esri.arcgis.interop.Dispatch
Throws:
java.io.IOException

setBorderStyle

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

Specified by:
setBorderStyle in interface IARControlDefault
Parameters:
rhs1 - 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 IARControlDefault
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 rhs1)
                     throws java.io.IOException,
                            AutomationException
Indicates whether the control can respond to user generated events.

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

esri_isEnabled

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

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

setAppearance

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

Specified by:
setAppearance in interface IARControlDefault
Parameters:
rhs1 - 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 IARControlDefault
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 IARControlDefault
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 IARControlDefault
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 IARControlDefault
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 IARControlDefault
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.

setCurrentViewByRef

public void setCurrentViewByRef(java.lang.Object rhs1)
                         throws java.io.IOException,
                                AutomationException
The current map or page layout view.

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

getCurrentView

public java.lang.Object getCurrentView()
                                throws java.io.IOException,
                                       AutomationException
The current map or page layout view.

Specified by:
getCurrentView in interface IARControlDefault
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.

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

getARPageLayout

public IARPageLayout getARPageLayout()
                              throws java.io.IOException,
                                     AutomationException
The page layout contained within the currently loaded document.

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

showARWindow

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

Specified by:
showARWindow in interface IARControlDefault
Parameters:
win - A com.esri.arcgis.controls.esriARWindows 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.

isARWindowVisible

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

Specified by:
isARWindowVisible in interface IARControlDefault
Parameters:
win - A com.esri.arcgis.controls.esriARWindows constant (in)
Returns:
The returnValue
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

suppressResizeDrawing

public void suppressResizeDrawing(boolean suppressResize,
                                  int resizeHWnd)
                           throws java.io.IOException,
                                  AutomationException
Suppress full redraw of control during resize operations.

Specified by:
suppressResizeDrawing in interface IARControlDefault
Parameters:
suppressResize - The suppressResize (in)
resizeHWnd - The resizeHWnd (in, optional, pass 0 if not required)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTOCWidth

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

Specified by:
setTOCWidth in interface IARControlDefault
Parameters:
rhs1 - The rhs1 (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 IARControlDefault
Returns:
The returnValue
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 IARControlDefault
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 IARControlDefault
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCurrentARTool

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

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

getCurrentARTool

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

Specified by:
getCurrentARTool in interface IARControlDefault
Returns:
A com.esri.arcgis.controls.esriARTool constant
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 IARControlDefault
Parameters:
docPermission - A com.esri.arcgis.controls.esriARDocumentPermissions constant (in)
Returns:
The returnValue
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setShowScrollbars

public void setShowScrollbars(int viewType,
                              boolean rhs2)
                       throws java.io.IOException,
                              AutomationException
Indicates if the map and page layout scrollbars are visible.

Specified by:
setShowScrollbars in interface IARControlDefault
Parameters:
viewType - A com.esri.arcgis.controls.esriARViewType constant (in)
rhs2 - The rhs2 (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isShowScrollbars

public boolean isShowScrollbars(int viewType)
                         throws java.io.IOException,
                                AutomationException
Indicates if the map and page layout scrollbars are visible.

Specified by:
isShowScrollbars in interface IARControlDefault
Parameters:
viewType - A com.esri.arcgis.controls.esriARViewType constant (in)
Returns:
The returnValue
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTOCVisible

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

Specified by:
setTOCVisible in interface IARControlDefault
Parameters:
rhs1 - The rhs1 (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 IARControlDefault
Returns:
The returnValue
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 IARControlDefault
Returns:
The returnValue
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setShowMapTips

public void setShowMapTips(boolean rhs1)
                    throws java.io.IOException,
                           AutomationException
Indicates if map tips are shown when the current view is a map or page layout.

Specified by:
setShowMapTips in interface IARControlDefault
Parameters:
rhs1 - The rhs1 (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isShowMapTips

public boolean isShowMapTips()
                      throws java.io.IOException,
                             AutomationException
Indicates if map tips are shown when the current view is a map or page layout.

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

refresh

public void refresh(boolean refreshNow)
             throws java.io.IOException,
                    AutomationException
Refresh the control's window.

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

getCurrentViewType

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

Specified by:
getCurrentViewType in interface IARControlDefault
Returns:
A com.esri.arcgis.controls.esriARViewType constant
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 IARControlDefault
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.

setARConfigurationByRef

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

Specified by:
setARConfigurationByRef in interface IARControlDefault
Parameters:
rhs1 - 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.

getARUnitConverter

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

Specified by:
getARUnitConverter in interface IARControlDefault
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.

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

setDocumentFilename

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

Specified by:
setDocumentFilename in interface IARControlDefault
Parameters:
rhs1 - The rhs1 (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 IARControlDefault
Parameters:
sFilename - The sFilename (in)
Returns:
The returnValue
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getARCommandInfo

public IARCommandInfo getARCommandInfo(int tool)
                                throws java.io.IOException,
                                       AutomationException
The ARCommandInfo contained by the control.

Specified by:
getARCommandInfo in interface IARControlDefault
Parameters:
tool - A com.esri.arcgis.controls.esriARTool constant (in)
Returns:
A reference to a com.esri.arcgis.controls.IARCommandInfo
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
Export the current map or page layout view to the file.

Specified by:
exportView in interface IARControlDefault
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.

setEnableFileDrop

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

Specified by:
setEnableFileDrop in interface IARControlDefault
Parameters:
rhs1 - The rhs1 (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 IARControlDefault
Returns:
The returnValue
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCustomProperty

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

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

setCustomProperty

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

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

getObject

public java.lang.Object getObject()
                           throws java.io.IOException,
                                  AutomationException
A property that returns the underlying control. This can be used when the control is inside a wrapper object that has been added by a development environment.

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

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 Active View.

Specified by:
getViewTop in interface IARControlDefault
Returns:
The returnValue
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 Active View.

Specified by:
getViewLeft in interface IARControlDefault
Returns:
The returnValue
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 Active View in pixels.

Specified by:
getViewHeight in interface IARControlDefault
Returns:
The returnValue
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 Active View in pixels.

Specified by:
getViewWidth in interface IARControlDefault
Returns:
The returnValue
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
Is the current PMF using settings stored in the PMF.

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

setSwipeLayerByRef

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

Specified by:
setSwipeLayerByRef in interface IARControlDefault
Parameters:
rhs1 - 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 IARControlDefault
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 IARControlDefault
Returns:
The returnValue
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMousePointer

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

Specified by:
setMousePointer in interface IARControlDefault
Parameters:
rhs1 - 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 document.

Specified by:
getMousePointer in interface IARControlDefault
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 IARControlDefault
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.