com.esri.arcgis.controls
Class IARPageLayoutProxy

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

public class IARPageLayoutProxy
extends com.esri.arcgis.interop.Dispatch
implements IARPageLayout, java.io.Serializable

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

Description: 'Provides access to members that control the ARPageLayout.' 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.IARPageLayout
DISPID_1_NAME, DISPID_10_NAME, DISPID_11_NAME, DISPID_12_GET_NAME, DISPID_13_NAME, DISPID_14_NAME, DISPID_15_NAME, DISPID_16_NAME, DISPID_17_NAME, DISPID_18_GET_NAME, DISPID_19_GET_NAME, DISPID_2_NAME, DISPID_20_NAME, DISPID_21_GET_NAME, DISPID_22_NAME, DISPID_23_GET_NAME, DISPID_24_NAME, DISPID_25_GET_NAME, DISPID_26_GET_NAME, DISPID_26_PUT_NAME, DISPID_27_GET_NAME, DISPID_27_PUT_NAME, DISPID_28_GET_NAME, DISPID_3_GET_NAME, DISPID_3_PUTREF_NAME, DISPID_4_GET_NAME, DISPID_5_GET_NAME, DISPID_6_GET_NAME, DISPID_6_PUT_NAME, DISPID_7_GET_NAME, DISPID_8_NAME, DISPID_9_NAME, IID, IIDd1fd0345_ef40_4ff9_a7b9_c6db6f4e8717
 
Constructor Summary
  IARPageLayoutProxy()
          For internal use only
  IARPageLayoutProxy(java.lang.Object obj)
           
protected IARPageLayoutProxy(java.lang.Object obj, java.lang.String iid)
           
  IARPageLayoutProxy(java.lang.String CLSID, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
           
protected IARPageLayoutProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
           
 
Method Summary
 void addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource)
           
 void centerAt(double xCoord, double yCoord)
          Moves the center of the page layout to the specified point.
 IARMap getARMap(int index)
          The map at the specified index.
 int getARMapCount()
          The number of maps in the page layout's map collection.
 java.lang.Object getCustomProperty()
          A property to associate data with an object.
 void getExtent(double[] xMin, double[] yMin, double[] xMax, double[] yMax)
          The visible extent of the page layout.
 IARMap getFocusARMap()
          The current focus map that the current tool acts upon.
 double getHeight()
          The height of the page.
 java.lang.Object getInternalObject()
          The internal ArcObjects IPageLayout object.
 int getMapExtentType(IARMap pMap)
          The extent type of the specified map.
 int getPageUnits()
          The units of the page and all associated coordinates.
 java.lang.String getTitle()
          The title in the page layout.
 double getWidth()
          The width of the page.
 double getZoomPercent()
          The zoom percent (100 means 1:1, 200 means twice the normal size).
 IARMap hitTestMap(int x, int y)
          Returns the first map present in the page layout at the specified coordinates.
 boolean isCanRedoExtent()
          Indicates if there is a page layout extent that can be redone.
 boolean isCanUndoExtent()
          Indicates if there is a page layout extent that can be undone.
 boolean isHasTitle()
          Indicates if the page layout has a title that can be changed.
 void pan(int direction, double screenPercentage)
          Pans the page layout by a factor in a specified direction.
 void redoExtent()
          Redo the next page layout extent in the stack.
 void refresh(boolean refreshNow)
          Redraws the page layout display area.
 void removeListener(java.lang.String iidStr, java.lang.Object theListener)
           
 void setCustomProperty(java.lang.Object pVal)
          A property to associate data with an object.
 void setExtent(double xMin, double yMin, double xMax, double yMax)
          Sets the visible extent of the page layout.
 void setFocusARMapByRef(IARMap ppARMap)
          The current focus map that the current tool acts upon.
 void setPageUnits(int units)
          The units of the page and all associated coordinates.
 void setTitle(java.lang.String currentTitle)
          The title in the page layout.
 void toPagePoint(int x, int y, double[] xCoord, double[] yCoord)
          Converts a point in device coordinates (typically pixels) to coordinates in page units.
 void undoExtent()
          Undo to the previous page layout extent in the stack.
 void zoomIn(double factor)
          Zooms in on the page layout by a factor.
 void zoomOut(double factor)
          Zooms out on the page layout by a factor.
 void zoomToPercent(int percent)
          Magnifies the page by a percentage (100 means actual size, 200 means twice the normal size).
 void zoomToWholePage()
          Zooms to the whole page.
 void zoomToWidth()
          Fits the width of the page into the page layout display area.
 
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

IARPageLayoutProxy

public IARPageLayoutProxy(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

IARPageLayoutProxy

public IARPageLayoutProxy()
For internal use only


IARPageLayoutProxy

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

IARPageLayoutProxy

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

IARPageLayoutProxy

protected IARPageLayoutProxy(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

setExtent

public void setExtent(double xMin,
                      double yMin,
                      double xMax,
                      double yMax)
               throws java.io.IOException,
                      AutomationException
Sets the visible extent of the page layout.

Specified by:
setExtent in interface IARPageLayout
Parameters:
xMin - The xMin (in)
yMin - The yMin (in)
xMax - The xMax (in)
yMax - The yMax (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtent

public void getExtent(double[] xMin,
                      double[] yMin,
                      double[] xMax,
                      double[] yMax)
               throws java.io.IOException,
                      AutomationException
The visible extent of the page layout.

Specified by:
getExtent in interface IARPageLayout
Parameters:
xMin - The xMin (in/out: use single element array)
yMin - The yMin (in/out: use single element array)
xMax - The xMax (in/out: use single element array)
yMax - The yMax (in/out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFocusARMapByRef

public void setFocusARMapByRef(IARMap ppARMap)
                        throws java.io.IOException,
                               AutomationException
The current focus map that the current tool acts upon.

Specified by:
setFocusARMapByRef in interface IARPageLayout
Parameters:
ppARMap - A reference to a com.esri.arcgis.controls.IARMap (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFocusARMap

public IARMap getFocusARMap()
                     throws java.io.IOException,
                            AutomationException
The current focus map that the current tool acts upon.

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

getARMapCount

public int getARMapCount()
                  throws java.io.IOException,
                         AutomationException
The number of maps in the page layout's map collection.

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

getARMap

public IARMap getARMap(int index)
                throws java.io.IOException,
                       AutomationException
The map at the specified index.

Specified by:
getARMap in interface IARPageLayout
Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.controls.IARMap
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPageUnits

public void setPageUnits(int units)
                  throws java.io.IOException,
                         AutomationException
The units of the page and all associated coordinates.

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

getPageUnits

public int getPageUnits()
                 throws java.io.IOException,
                        AutomationException
The units of the page and all associated coordinates.

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

getZoomPercent

public double getZoomPercent()
                      throws java.io.IOException,
                             AutomationException
The zoom percent (100 means 1:1, 200 means twice the normal size).

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

zoomToPercent

public void zoomToPercent(int percent)
                   throws java.io.IOException,
                          AutomationException
Magnifies the page by a percentage (100 means actual size, 200 means twice the normal size).

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

zoomToWholePage

public void zoomToWholePage()
                     throws java.io.IOException,
                            AutomationException
Zooms to the whole page.

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

zoomToWidth

public void zoomToWidth()
                 throws java.io.IOException,
                        AutomationException
Fits the width of the page into the page layout display area.

Specified by:
zoomToWidth in interface IARPageLayout
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
Redraws the page layout display area.

Specified by:
refresh in interface IARPageLayout
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.

getMapExtentType

public int getMapExtentType(IARMap pMap)
                     throws java.io.IOException,
                            AutomationException
The extent type of the specified map.

Specified by:
getMapExtentType in interface IARPageLayout
Parameters:
pMap - A reference to a com.esri.arcgis.controls.IARMap (in)
Returns:
A com.esri.arcgis.controls.esriARExtentType constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

hitTestMap

public IARMap hitTestMap(int x,
                         int y)
                  throws java.io.IOException,
                         AutomationException
Returns the first map present in the page layout at the specified coordinates. If there isn't a map or the coordinates are not over a map, nothing will be returned.

Specified by:
hitTestMap in interface IARPageLayout
Parameters:
x - The x (in)
y - The y (in)
Returns:
A reference to a com.esri.arcgis.controls.IARMap
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

zoomIn

public void zoomIn(double factor)
            throws java.io.IOException,
                   AutomationException
Zooms in on the page layout by a factor.

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

zoomOut

public void zoomOut(double factor)
             throws java.io.IOException,
                    AutomationException
Zooms out on the page layout by a factor.

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

pan

public void pan(int direction,
                double screenPercentage)
         throws java.io.IOException,
                AutomationException
Pans the page layout by a factor in a specified direction.

Specified by:
pan in interface IARPageLayout
Parameters:
direction - A com.esri.arcgis.controls.esriARDirection constant (in)
screenPercentage - The screenPercentage (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

centerAt

public void centerAt(double xCoord,
                     double yCoord)
              throws java.io.IOException,
                     AutomationException
Moves the center of the page layout to the specified point.

Specified by:
centerAt in interface IARPageLayout
Parameters:
xCoord - The xCoord (in)
yCoord - The yCoord (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getWidth

public double getWidth()
                throws java.io.IOException,
                       AutomationException
The width of the page.

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

getHeight

public double getHeight()
                 throws java.io.IOException,
                        AutomationException
The height of the page.

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

toPagePoint

public void toPagePoint(int x,
                        int y,
                        double[] xCoord,
                        double[] yCoord)
                 throws java.io.IOException,
                        AutomationException
Converts a point in device coordinates (typically pixels) to coordinates in page units.

Specified by:
toPagePoint in interface IARPageLayout
Parameters:
x - The x (in)
y - The y (in)
xCoord - The xCoord (in/out: use single element array)
yCoord - The yCoord (in/out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCanUndoExtent

public boolean isCanUndoExtent()
                        throws java.io.IOException,
                               AutomationException
Indicates if there is a page layout extent that can be undone.

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

undoExtent

public void undoExtent()
                throws java.io.IOException,
                       AutomationException
Undo to the previous page layout extent in the stack.

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

isCanRedoExtent

public boolean isCanRedoExtent()
                        throws java.io.IOException,
                               AutomationException
Indicates if there is a page layout extent that can be redone.

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

redoExtent

public void redoExtent()
                throws java.io.IOException,
                       AutomationException
Redo the next page layout extent in the stack.

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

getInternalObject

public java.lang.Object getInternalObject()
                                   throws java.io.IOException,
                                          AutomationException
The internal ArcObjects IPageLayout object.

Specified by:
getInternalObject in interface IARPageLayout
Returns:
A reference to another Object (IUnknown)
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 an object.

Specified by:
getCustomProperty in interface IARPageLayout
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 an object.

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

setTitle

public void setTitle(java.lang.String currentTitle)
              throws java.io.IOException,
                     AutomationException
The title in the page layout. Not all page layouts have a title that can be changed, use the HasTitle method to check this.

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

getTitle

public java.lang.String getTitle()
                          throws java.io.IOException,
                                 AutomationException
The title in the page layout. Not all page layouts have a title that can be changed, use the HasTitle method to check this.

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

isHasTitle

public boolean isHasTitle()
                   throws java.io.IOException,
                          AutomationException
Indicates if the page layout has a title that can be changed.

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