ARPageLayout (ArcObjects Java API)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.controls
Class ARPageLayout

java.lang.Object
  com.esri.arcgis.controls.ARPageLayout

All Implemented Interfaces:: IARPageLayout, java.io.Serializable

public class ARPageLayout
extends java.lang.Object
implements IARPageLayout

The ARPageLayout container for the display of a page.

Product Availability

Available with ArcGIS Engine.

See Also:: Serialized Form

Constructor Summary
`ARPageLayout(java.lang.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(java.lang.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.
`IARPageLayout`	`getAsIARPageLayout()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`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).
`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(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 java.lang.Object

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

Constructor Detail

ARPageLayout

public ARPageLayout(java.lang.Object obj)
             throws java.io.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 ARPageLayout theARPageLayout = (ARPageLayout) obj;
Throws:: java.io.IOException - if there are interop problems

Method Detail

getAsIARPageLayout

public IARPageLayout getAsIARPageLayout()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

hashCode

public int hashCode()

the hashcode for this object