com.esri.arcgis.controls
Class ARPageLayout

java.lang.Object
  extended by com.esri.arcgis.controls.ARPageLayout
All Implemented Interfaces:
IARPageLayout, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class ARPageLayout
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IARPageLayout

The ARPageLayout container for the display of a page.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

See Also:
Serialized Form

Constructor Summary
ARPageLayout(Object obj)
          Construct a ARPageLayout using a reference to such an object returned from ArcGIS Engine or Server.
 
Method Summary
 void centerAt(double xCoord, double yCoord)
          Moves the center of the page layout to the specified point.
 boolean equals(Object o)
          Compare this object with another
 IARMap getARMap(int index)
          The map at the specified index.
 int getARMapCount()
          The number of maps in the page layout's map collection.
 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.
 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.
 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).
 int hashCode()
          the hashcode for this object
 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 setCustomProperty(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(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 java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

ARPageLayout

public ARPageLayout(Object obj)
             throws IOException
Construct a ARPageLayout using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ARPageLayout.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
ARPageLayout o = (ARPageLayout)obj; // will not work

ARPageLayout o = new ARPageLayout(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:
IOException - if there are interop problems ARPageLayout theARPageLayout = (ARPageLayout) obj;
Method Detail

equals

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

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

setExtent

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

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
setExtent in interface IARPageLayout
Parameters:
xMin - The xMin (in)
yMin - The yMin (in)
xMax - The xMax (in)
yMax - The yMax (in)
Throws:
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 IOException,
                      AutomationException
The visible extent of the page layout.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

setFocusARMapByRef

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

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

getFocusARMap

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

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

getARMapCount

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

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

getARMap

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

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

setPageUnits

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

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

getPageUnits

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

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

getZoomPercent

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

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

zoomToPercent

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

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

zoomToWholePage

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

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

zoomToWidth

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

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

refresh

public void refresh(boolean refreshNow)
             throws IOException,
                    AutomationException
Redraws the page layout display area.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

getMapExtentType

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

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

hitTestMap

public IARMap hitTestMap(int x,
                         int y)
                  throws 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.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

zoomIn

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

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

zoomOut

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

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

pan

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

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

centerAt

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

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

getWidth

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

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

getHeight

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

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
getHeight in interface IARPageLayout
Returns:
The dHeight
Throws:
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 IOException,
                        AutomationException
Converts a point in device coordinates (typically pixels) to coordinates in page units.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

isCanUndoExtent

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

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

undoExtent

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

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

isCanRedoExtent

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

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

redoExtent

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

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

getInternalObject

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

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

setTitle

public void setTitle(String currentTitle)
              throws 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.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

getTitle

public String getTitle()
                throws 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.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

isHasTitle

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

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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