|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.carto.Page
public class Page
COM Class 'Page'. Generated 3/19/2015 1:20:41 PM from 'C:\ArcGIS\COM\esriCarto.olb'
Description 'The On Screen 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 long |
serialVersionUID
|
Fields inherited from interface com.esri.arcgis.carto.IPage |
---|
IID, IID2ab4981f_9406_11d0_87ef_080009ec732a, xxDummy |
Fields inherited from interface com.esri.arcgis.carto.IFrameProperties |
---|
IID, IIDd1b1b855_5885_4d7f_a444_a02e3e1078c3, xxDummy |
Fields inherited from interface com.esri.arcgis.system.IPropertySupport |
---|
IID, IID8a11ad55_2f4f_11d3_9fa0_00c04f6bc6a5, xxDummy |
Fields inherited from interface com.esri.arcgis.display.IConnectionPointContainer |
---|
IID, IIDb196b284_bab4_101a_b69c_00aa00341d07, xxDummy |
Fields inherited from interface com.esri.arcgis.system.IPersistStream |
---|
IID, IID00000109_0000_0000_c000_000000000046, xxDummy |
Fields inherited from interface com.esri.arcgis.system.IPersist |
---|
IID0000010c_0000_0000_c000_000000000046 |
Fields inherited from interface com.esri.arcgis.system.IClone |
---|
IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy |
Constructor Summary | |
---|---|
Page()
Constructs a Page using ArcGIS Engine. |
|
Page(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. Page thePage = (Page) obj; |
Method Summary | |
---|---|
void |
addIPageEventsListener(IPageEvents theListener)
addIPageEventsListener. |
boolean |
applies(java.lang.Object pUnk)
Indicates if the receiver can apply the given object at any given time. |
java.lang.Object |
apply(java.lang.Object newObject)
Applies the given property to the receiver and returns the old object. |
void |
assign(IClone src)
Assigns the properties of src to the receiver. |
boolean |
canApply(java.lang.Object pUnk)
Indicates if the receiver can apply the given object at that particular moment. |
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. |
void |
enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
enumConnectionPoints |
boolean |
equals(java.lang.Object o)
Compare this object with another |
IClone |
esri_clone()
Clones the receiver and assigns the result to *clone. |
void |
findConnectionPoint(GUID riid,
IConnectionPoint[] ppCP)
findConnectionPoint |
IBackground |
getBackground()
The page background. |
IColor |
getBackgroundColor()
The page color. |
IBorder |
getBorder()
The page border. |
void |
getClassID(GUID[] pClassID)
getClassID |
static java.lang.String |
getClsid()
getClsid. |
java.lang.Object |
getCurrent(java.lang.Object pUnk)
The object currently being used. |
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. |
com.esri.arcgis.interop.Dispatch |
getJintegraDispatch()
Deprecated. Internal use only. |
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. |
IShadow |
getShadow()
Frame shadow used by this element. |
void |
getSizeMax(_ULARGE_INTEGER[] pcbSize)
getSizeMax |
int |
getUnits()
The units used for the page and all associated coordinates. |
int |
hashCode()
the hashcode for this object |
IBackground |
IFrameProperties_getBackground()
Frame background used by this element. |
boolean |
isDelayEvents()
Indicates if the page stops firing IPageEvents until the flag is set to false. |
void |
isDirty()
isDirty |
boolean |
isEqual(IClone other)
Indicates if the receiver and other have the same properties. |
boolean |
isIdentical(IClone other)
Indicates if the receiver and other are the same object. |
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 |
load(IStream pstm)
load |
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 |
readExternal(java.io.ObjectInput in)
|
void |
release()
Release a Page. |
void |
removeIPageEventsListener(IPageEvents theListener)
removeIPageEventsListener. |
void |
save(IStream pstm,
int fClearDirty)
save |
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 |
setShadow(IShadow shadow)
Frame shadow used by this element. |
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. |
void |
writeExternal(java.io.ObjectOutput out)
|
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final long serialVersionUID
Constructor Detail |
---|
public Page() throws java.io.IOException, java.net.UnknownHostException
java.io.IOException
- if there are interop problems
java.net.UnknownHostException
- if there are interop problemspublic Page(java.lang.Object obj) throws java.io.IOException
Page thePage = (Page) obj;
obj
to Page
.
obj
- an object returned from ArcGIS Engine or Server
java.io.IOException
- if there are interop problemsMethod Detail |
---|
public static java.lang.String getClsid()
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
getJintegraDispatch
in interface com.esri.arcgis.interop.RemoteObjRef
public void addIPageEventsListener(IPageEvents theListener) throws java.io.IOException
theListener
- An object that implements the com.esri.arcgis.carto.IPageEvents interface.
java.io.IOException
- If there are communications problems.public void removeIPageEventsListener(IPageEvents theListener) throws java.io.IOException
theListener
- An object that implements the com.esri.arcgis.carto.IPageEvents interface.
java.io.IOException
- If there are communications problems.public void release()
release
in interface com.esri.arcgis.interop.RemoteObjRef
public int getFormID() throws java.io.IOException, AutomationException
getFormID
in interface IPage
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setFormID(int formID) throws java.io.IOException, AutomationException
setFormID
in interface IPage
formID
- A com.esri.arcgis.carto.esriPageFormID constant (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public short getOrientation() throws java.io.IOException, AutomationException
getOrientation
in interface IPage
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setOrientation(short orientation) throws java.io.IOException, AutomationException
setOrientation
in interface IPage
orientation
- The orientation (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getUnits() throws java.io.IOException, AutomationException
getUnits
in interface IPage
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setUnits(int units) throws java.io.IOException, AutomationException
setUnits
in interface IPage
units
- A com.esri.arcgis.system.esriUnits constant (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IEnvelope getPrintableBounds() throws java.io.IOException, AutomationException
getPrintableBounds
in interface IPage
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isPrintableAreaVisible() throws java.io.IOException, AutomationException
isPrintableAreaVisible
in interface IPage
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setIsPrintableAreaVisible(boolean isPrintableAreaVisible) throws java.io.IOException, AutomationException
setIsPrintableAreaVisible
in interface IPage
isPrintableAreaVisible
- The isPrintableAreaVisible (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isStretchGraphicsWithPage() throws java.io.IOException, AutomationException
isStretchGraphicsWithPage
in interface IPage
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setStretchGraphicsWithPage(boolean stretchGraphicsWithPage) throws java.io.IOException, AutomationException
setStretchGraphicsWithPage
in interface IPage
stretchGraphicsWithPage
- The stretchGraphicsWithPage (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IColor getBackgroundColor() throws java.io.IOException, AutomationException
getBackgroundColor
in interface IPage
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setBackgroundColor(IColor color) throws java.io.IOException, AutomationException
setBackgroundColor
in interface IPage
color
- A reference to a com.esri.arcgis.display.IColor (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IBorder getBorder() throws java.io.IOException, AutomationException
getBorder
in interface IFrameProperties
getBorder
in interface IPage
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setBorder(IBorder border) throws java.io.IOException, AutomationException
setBorder
in interface IFrameProperties
setBorder
in interface IPage
border
- A reference to a com.esri.arcgis.carto.IBorder (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IBackground getBackground() throws java.io.IOException, AutomationException
getBackground
in interface IPage
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setBackground(IBackground background) throws java.io.IOException, AutomationException
setBackground
in interface IFrameProperties
setBackground
in interface IPage
background
- A reference to a com.esri.arcgis.carto.IBackground (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isDelayEvents() throws java.io.IOException, AutomationException
isDelayEvents
in interface IPage
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setDelayEvents(boolean delayEvents) throws java.io.IOException, AutomationException
setDelayEvents
in interface IPage
delayEvents
- The delayEvents (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getPageToPrinterMapping() throws java.io.IOException, AutomationException
getPageToPrinterMapping
in interface IPage
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setPageToPrinterMapping(int mode) throws java.io.IOException, AutomationException
setPageToPrinterMapping
in interface IPage
mode
- A com.esri.arcgis.carto.esriPageToPrinterMapping constant (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void querySize(double[] width, double[] height) throws java.io.IOException, AutomationException
querySize
in interface IPage
width
- The width (out: use single element array)height
- The height (out: use single element array)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void putCustomSize(double width, double height) throws java.io.IOException, AutomationException
putCustomSize
in interface IPage
width
- The width (in)height
- The height (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void printerPageCount(IPrinter printer, double overlap, short[] pageCount) throws java.io.IOException, AutomationException
printerPageCount
in interface IPage
printer
- A reference to a com.esri.arcgis.output.IPrinter (in)overlap
- The overlap (in)pageCount
- The pageCount (out: use single element array)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void getPageBounds(IPrinter printer, short currentPage, double overlap, IEnvelope pageBounds) throws java.io.IOException, AutomationException
getPageBounds
in interface IPage
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)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void getDeviceBounds(IPrinter printer, short currentPage, double overlap, short resolution, IEnvelope deviceBounds) throws java.io.IOException, AutomationException
getDeviceBounds
in interface IPage
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)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void drawPaper(IDisplay display, IColor eraseColor) throws java.io.IOException, AutomationException
drawPaper
in interface IPage
display
- A reference to a com.esri.arcgis.display.IDisplay (in)eraseColor
- A reference to a com.esri.arcgis.display.IColor (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void drawBackground(IDisplay display) throws java.io.IOException, AutomationException
drawBackground
in interface IPage
display
- A reference to a com.esri.arcgis.display.IDisplay (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void drawPrintableArea(IDisplay display) throws java.io.IOException, AutomationException
drawPrintableArea
in interface IPage
display
- A reference to a com.esri.arcgis.display.IDisplay (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void drawBorder(IDisplay display) throws java.io.IOException, AutomationException
drawBorder
in interface IPage
display
- A reference to a com.esri.arcgis.display.IDisplay (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void printerChanged(IPrinter printer) throws java.io.IOException, AutomationException
printerChanged
in interface IPage
printer
- A reference to a com.esri.arcgis.output.IPrinter (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IBackground IFrameProperties_getBackground() throws java.io.IOException, AutomationException
IFrameProperties_getBackground
in interface IFrameProperties
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IShadow getShadow() throws java.io.IOException, AutomationException
getShadow
in interface IFrameProperties
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setShadow(IShadow shadow) throws java.io.IOException, AutomationException
setShadow
in interface IFrameProperties
shadow
- A reference to a com.esri.arcgis.carto.IShadow (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean applies(java.lang.Object pUnk) throws java.io.IOException, AutomationException
applies
in interface IPropertySupport
pUnk
- A reference to another Object (IUnknown) (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean canApply(java.lang.Object pUnk) throws java.io.IOException, AutomationException
canApply
in interface IPropertySupport
pUnk
- A reference to another Object (IUnknown) (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public java.lang.Object getCurrent(java.lang.Object pUnk) throws java.io.IOException, AutomationException
getCurrent
in interface IPropertySupport
pUnk
- A reference to another Object (IUnknown) (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public java.lang.Object apply(java.lang.Object newObject) throws java.io.IOException, AutomationException
apply
in interface IPropertySupport
newObject
- A reference to another Object (IUnknown) (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void enumConnectionPoints(IEnumConnectionPoints[] ppEnum) throws java.io.IOException, AutomationException
enumConnectionPoints
in interface IConnectionPointContainer
ppEnum
- A reference to a com.esri.arcgis.display.IEnumConnectionPoints (out: use single element array)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void findConnectionPoint(GUID riid, IConnectionPoint[] ppCP) throws java.io.IOException, AutomationException
findConnectionPoint
in interface IConnectionPointContainer
riid
- A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)ppCP
- A reference to a com.esri.arcgis.display.IConnectionPoint (out: use single element array)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void isDirty() throws java.io.IOException, AutomationException
isDirty
in interface IPersistStream
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void load(IStream pstm) throws java.io.IOException, AutomationException
load
in interface IPersistStream
pstm
- A reference to a com.esri.arcgis.system.IStream (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void save(IStream pstm, int fClearDirty) throws java.io.IOException, AutomationException
save
in interface IPersistStream
pstm
- A reference to a com.esri.arcgis.system.IStream (in)fClearDirty
- The fClearDirty (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void getSizeMax(_ULARGE_INTEGER[] pcbSize) throws java.io.IOException, AutomationException
getSizeMax
in interface IPersistStream
pcbSize
- A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void getClassID(GUID[] pClassID) throws java.io.IOException, AutomationException
getClassID
in interface IPersist
pClassID
- A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IClone esri_clone() throws java.io.IOException, AutomationException
esri_clone
in interface IClone
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void assign(IClone src) throws java.io.IOException, AutomationException
assign
in interface IClone
src
- A reference to a com.esri.arcgis.system.IClone (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isEqual(IClone other) throws java.io.IOException, AutomationException
isEqual
in interface IClone
other
- A reference to a com.esri.arcgis.system.IClone (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isIdentical(IClone other) throws java.io.IOException, AutomationException
isIdentical
in interface IClone
other
- A reference to a com.esri.arcgis.system.IClone (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void writeExternal(java.io.ObjectOutput out) throws java.io.IOException
writeExternal
in interface java.io.Externalizable
java.io.IOException
public void readExternal(java.io.ObjectInput in) throws java.io.IOException, java.lang.ClassNotFoundException
readExternal
in interface java.io.Externalizable
java.io.IOException
java.lang.ClassNotFoundException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |