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.carto
Interface IPage

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
IPageProxy, Page
public interface IPage
extends java.io.Serializable

COM Interface 'IPage'. Generated 3/19/2015 1:20:53 PM from 'C:\ArcGIS\COM\esriCarto.olb'

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

Field Summary
static java.lang.String IID
          Deprecated. Internal use only
static int IID2ab4981f_9406_11d0_87ef_080009ec732a
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 void drawBackground(IDisplay display)
          Draw the page background.
 void drawBorder(IDisplay display)
          Draw the page border.
 void drawPaper(IDisplay display, IColor eraseColor)
          Draw the paper.
 void drawPrintableArea(IDisplay display)
          Draw the printable area.
 IBackground getBackground()
          The page background.
 IColor getBackgroundColor()
          The page color.
 IBorder getBorder()
          The page border.
 void getDeviceBounds(IPrinter printer, short currentPage, double overlap, short resolution, IEnvelope deviceBounds)
          Return the printer page size in device units.
 int getFormID()
          The Page form.
 short getOrientation()
          The Page orientation.
 void getPageBounds(IPrinter printer, short currentPage, double overlap, IEnvelope pageBounds)
          Return the page size in page units.
 int getPageToPrinterMapping()
          The page to printer mapping.
 IEnvelope getPrintableBounds()
          The printable bounds.
 int getUnits()
          The units used for the page and all associated coordinates.
 boolean isDelayEvents()
          Indicates if the page stops firing IPageEvents until the flag is set to false.
 boolean isPrintableAreaVisible()
          Indicates if the printable area is visible.
 boolean isStretchGraphicsWithPage()
          Indicates if graphics should stretch with the page when the page size changes.
 void printerChanged(IPrinter printer)
          Called by PageLayout when printer changes.
 void printerPageCount(IPrinter printer, double overlap, short[] pageCount)
          The number of printer pages spanned by the page.
 void putCustomSize(double width, double height)
          The size of the page in page units.
 void querySize(double[] width, double[] height)
          The size of the page in page units.
 void setBackground(IBackground background)
          The page background.
 void setBackgroundColor(IColor color)
          The page color.
 void setBorder(IBorder border)
          The page border.
 void setDelayEvents(boolean delayEvents)
          Indicates if the page stops firing IPageEvents until the flag is set to false.
 void setFormID(int formID)
          The Page form.
 void setIsPrintableAreaVisible(boolean isPrintableAreaVisible)
          Indicates if the printable area is visible.
 void setOrientation(short orientation)
          The Page orientation.
 void setPageToPrinterMapping(int mode)
          The page to printer mapping.
 void setStretchGraphicsWithPage(boolean stretchGraphicsWithPage)
          Indicates if graphics should stretch with the page when the page size changes.
 void setUnits(int units)
          The units used for the page and all associated coordinates.
 

Field Detail

IID2ab4981f_9406_11d0_87ef_080009ec732a

static final int IID2ab4981f_9406_11d0_87ef_080009ec732a
See Also:
Constant Field Values

xxDummy

static final int xxDummy
Deprecated. Internal use only
See Also:
Constant Field Values

IID

static final java.lang.String IID
Deprecated. Internal use only
See Also:
Constant Field Values
Method Detail

getFormID

int getFormID()
              throws java.io.IOException,
                     AutomationException
The Page form.

Returns:
A com.esri.arcgis.carto.esriPageFormID constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFormID

void setFormID(int formID)
               throws java.io.IOException,
                      AutomationException
The Page form.

Parameters:
formID - A com.esri.arcgis.carto.esriPageFormID constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOrientation

short getOrientation()
                     throws java.io.IOException,
                            AutomationException
The Page orientation. 1 = portrait. 2 = landscape.

Returns:
The orientation
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOrientation

void setOrientation(short orientation)
                    throws java.io.IOException,
                           AutomationException
The Page orientation. 1 = portrait. 2 = landscape.

Parameters:
orientation - The orientation (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getUnits

int getUnits()
             throws java.io.IOException,
                    AutomationException
The units used for the page and all associated coordinates.

Returns:
A com.esri.arcgis.system.esriUnits constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUnits

void setUnits(int units)
              throws java.io.IOException,
                     AutomationException
The units used for the page and all associated coordinates.

Parameters:
units - A com.esri.arcgis.system.esriUnits constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPrintableBounds

IEnvelope getPrintableBounds()
                             throws java.io.IOException,
                                    AutomationException
The printable bounds.

Returns:
A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isPrintableAreaVisible

boolean isPrintableAreaVisible()
                               throws java.io.IOException,
                                      AutomationException
Indicates if the printable area is visible.

Returns:
The isPrintableAreaVisible
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIsPrintableAreaVisible

void setIsPrintableAreaVisible(boolean isPrintableAreaVisible)
                               throws java.io.IOException,
                                      AutomationException
Indicates if the printable area is visible.

Parameters:
isPrintableAreaVisible - The isPrintableAreaVisible (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isStretchGraphicsWithPage

boolean isStretchGraphicsWithPage()
                                  throws java.io.IOException,
                                         AutomationException
Indicates if graphics should stretch with the page when the page size changes.

Returns:
The stretchGraphicsWithPage
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setStretchGraphicsWithPage

void setStretchGraphicsWithPage(boolean stretchGraphicsWithPage)
                                throws java.io.IOException,
                                       AutomationException
Indicates if graphics should stretch with the page when the page size changes.

Parameters:
stretchGraphicsWithPage - The stretchGraphicsWithPage (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBackgroundColor

IColor getBackgroundColor()
                          throws java.io.IOException,
                                 AutomationException
The page color.

Returns:
A reference to a com.esri.arcgis.display.IColor
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBackgroundColor

void setBackgroundColor(IColor color)
                        throws java.io.IOException,
                               AutomationException
The page color.

Parameters:
color - A reference to a com.esri.arcgis.display.IColor (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBorder

IBorder getBorder()
                  throws java.io.IOException,
                         AutomationException
The page border.

Returns:
A reference to a com.esri.arcgis.carto.IBorder
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBorder

void setBorder(IBorder border)
               throws java.io.IOException,
                      AutomationException
The page border.

Parameters:
border - A reference to a com.esri.arcgis.carto.IBorder (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBackground

IBackground getBackground()
                          throws java.io.IOException,
                                 AutomationException
The page background.

Returns:
A reference to a com.esri.arcgis.carto.IBackground
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBackground

void setBackground(IBackground background)
                   throws java.io.IOException,
                          AutomationException
The page background.

Parameters:
background - A reference to a com.esri.arcgis.carto.IBackground (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDelayEvents

boolean isDelayEvents()
                      throws java.io.IOException,
                             AutomationException
Indicates if the page stops firing IPageEvents until the flag is set to false.

Returns:
The delayEvents
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDelayEvents

void setDelayEvents(boolean delayEvents)
                    throws java.io.IOException,
                           AutomationException
Indicates if the page stops firing IPageEvents until the flag is set to false.

Parameters:
delayEvents - The delayEvents (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPageToPrinterMapping

int getPageToPrinterMapping()
                            throws java.io.IOException,
                                   AutomationException
The page to printer mapping.

Returns:
A com.esri.arcgis.carto.esriPageToPrinterMapping constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPageToPrinterMapping

void setPageToPrinterMapping(int mode)
                             throws java.io.IOException,
                                    AutomationException
The page to printer mapping.

Parameters:
mode - A com.esri.arcgis.carto.esriPageToPrinterMapping constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

querySize

void querySize(double[] width,
               double[] height)
               throws java.io.IOException,
                      AutomationException
The size of the page in page units.

Parameters:
width - The width (out: use single element array)
height - The height (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

putCustomSize

void putCustomSize(double width,
                   double height)
                   throws java.io.IOException,
                          AutomationException
The size of the page in page units.

Parameters:
width - The width (in)
height - The height (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

printerPageCount

void printerPageCount(IPrinter printer,
                      double overlap,
                      short[] pageCount)
                      throws java.io.IOException,
                             AutomationException
The number of printer pages spanned by the page.

Parameters:
printer - A reference to a com.esri.arcgis.output.IPrinter (in)
overlap - The overlap (in)
pageCount - The pageCount (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPageBounds

void getPageBounds(IPrinter printer,
                   short currentPage,
                   double overlap,
                   IEnvelope pageBounds)
                   throws java.io.IOException,
                          AutomationException
Return the page size in page units.

Parameters:
printer - A reference to a com.esri.arcgis.output.IPrinter (in)
currentPage - The currentPage (in)
overlap - The overlap (in)
pageBounds - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDeviceBounds

void getDeviceBounds(IPrinter printer,
                     short currentPage,
                     double overlap,
                     short resolution,
                     IEnvelope deviceBounds)
                     throws java.io.IOException,
                            AutomationException
Return the printer page size in device units.

Parameters:
printer - A reference to a com.esri.arcgis.output.IPrinter (in)
currentPage - The currentPage (in)
overlap - The overlap (in)
resolution - The resolution (in)
deviceBounds - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

drawPaper

void drawPaper(IDisplay display,
               IColor eraseColor)
               throws java.io.IOException,
                      AutomationException
Draw the paper. EraseColor is the color of the area surrounding the page. Only the area around the page is drawn in order to eliminate flashing. Use EraseColor = 0 to simply draw page.

Parameters:
display - A reference to a com.esri.arcgis.display.IDisplay (in)
eraseColor - A reference to a com.esri.arcgis.display.IColor (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

drawBackground

void drawBackground(IDisplay display)
                    throws java.io.IOException,
                           AutomationException
Draw the page background.

Parameters:
display - A reference to a com.esri.arcgis.display.IDisplay (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

drawPrintableArea

void drawPrintableArea(IDisplay display)
                       throws java.io.IOException,
                              AutomationException
Draw the printable area.

Parameters:
display - A reference to a com.esri.arcgis.display.IDisplay (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

drawBorder

void drawBorder(IDisplay display)
                throws java.io.IOException,
                       AutomationException
Draw the page border.

Parameters:
display - A reference to a com.esri.arcgis.display.IDisplay (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

printerChanged

void printerChanged(IPrinter printer)
                    throws java.io.IOException,
                           AutomationException
Called by PageLayout when printer changes.

Parameters:
printer - A reference to a com.esri.arcgis.output.IPrinter (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD