Page
Inheritance: java.lang.Object
public class Page
Contains elements that define a page in the document.
Constructors
| Constructor | Description |
|---|---|
| Page() | Constructor. |
| Page(int ID) | Constructor. |
Methods
Page()
public Page()
Constructor.
Page(int ID)
public Page(int ID)
Constructor.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| ID | int |
addActiveXControl(int type, double pinX, double pinY, double width, double height)
public long addActiveXControl(int type, double pinX, double pinY, double width, double height)
Creates an Activex Control.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| type | int | The type of the control. |
| pinX | double | Specifies the x-coordinate of the shape’s pin (center of rotation) in relation to the page. |
| pinY | double | Specifies the y-coordinate of the shape’s pin (center of rotation) in relation to the page. |
| width | double | Specifies the width of the shape in inches. |
| height | double | Specifies the height of the shape in inches. |
Returns: long -
addComment(Shape shape, String comment)
public void addComment(Shape shape, String comment)
Adds comment to a shape.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| shape | Shape | Specifies the shape which is adding comment . |
| comment | java.lang.String | Comment’s string. |
addComment(double pinX, double pinY, String comment)
public void addComment(double pinX, double pinY, String comment)
Adds comment with defined PinX and PinY.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| pinX | double | Specifies the x-coordinate of the comment’s pin (center of rotation) in relation to the page. |
| pinY | double | Specifies the y-coordinate of the comment’s pin (center of rotation) in relation to the page. |
| comment | java.lang.String | Comment’s string. |
addComment(long shapeID, String comment)
public void addComment(long shapeID, String comment)
Adds comment to a shape with shape’s id.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| shapeID | long | |
| comment | java.lang.String | Comment’s string. |
addShape(Shape newShape, String masterName)
public long addShape(Shape newShape, String masterName)
Adds shape created by master to specific page.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| newShape | Shape | New shape objectShape. |
| masterName | java.lang.String | Master’s name. |
Returns: long - The unique ID of the shape within shapes collection on the specified page.
addShape(double pinX, double pinY, double width, double height, InputStream stream)
public long addShape(double pinX, double pinY, double width, double height, InputStream stream)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| pinX | double | |
| pinY | double | |
| width | double | |
| height | double | |
| stream | java.io.InputStream |
Returns: long
addShape(double pinX, double pinY, double width, double height, InputStream imageStream, InputStream objectDataStream)
public long addShape(double pinX, double pinY, double width, double height, InputStream imageStream, InputStream objectDataStream)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| pinX | double | |
| pinY | double | |
| width | double | |
| height | double | |
| imageStream | java.io.InputStream | |
| objectDataStream | java.io.InputStream |
Returns: long
addShape(double pinX, double pinY, double width, double height, String masterName)
public long addShape(double pinX, double pinY, double width, double height, String masterName)
Adds shape created by master on page with defined PinX,PinY,Width and Height.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| pinX | double | Specifies the x-coordinate of the shape’s pin (center of rotation) in relation to the page. |
| pinY | double | Specifies the y-coordinate of the shape’s pin (center of rotation) in relation to the page. |
| width | double | Specifies the width of the shape in inches. |
| height | double | Specifies the height of the shape in inches. |
| masterName | java.lang.String | Master’s name. |
Returns: long - The unique ID of the shape within shapes collection on the specified page.
addShape(double pinX, double pinY, String masterName)
public long addShape(double pinX, double pinY, String masterName)
Adds shape created by master on page with defined PinX and PinY.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| pinX | double | Specifies the x-coordinate of the shape’s pin (center of rotation) in relation to the page. |
| pinY | double | Specifies the y-coordinate of the shape’s pin (center of rotation) in relation to the page. |
| masterName | java.lang.String | Master’s name. |
Returns: long - The unique ID of the shape within shapes collection on the specified page.
addText(double pinX, double pinY, double width, double height, String text)
public Shape addText(double pinX, double pinY, double width, double height, String text)
Adds Text with defined PinX and PinY.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| pinX | double | Specifies the x-coordinate of the text’s pin (center of rotation) in relation to the page. |
| pinY | double | Specifies the y-coordinate of the text’s pin (center of rotation) in relation to the page. |
| width | double | |
| height | double | |
| text | java.lang.String | text string. |
Returns: Shape - Returns a shape object that represents the new text object.
addText(double pinX, double pinY, double width, double height, String text, String fontName, String fontColor, double size)
public Shape addText(double pinX, double pinY, double width, double height, String text, String fontName, String fontColor, double size)
Adds Text with defined PinX and PinY.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| pinX | double | Specifies the x-coordinate of the text’s pin (center of rotation) in relation to the page. |
| pinY | double | Specifies the y-coordinate of the text’s pin (center of rotation) in relation to the page. |
| width | double | Specifies the width of the text. |
| height | double | Specifies the height of the text. |
| text | java.lang.String | text string. |
| fontName | java.lang.String | text font name. |
| fontColor | java.lang.String | text font color. |
| size | double | text font size. |
Returns: Shape - Returns a shape object that represents the new text object.
applyStyle(int textStyle, int lineStyle, int fillStyle)
public void applyStyle(int textStyle, int lineStyle, int fillStyle)
Applies style for full page. Default value is -1.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| textStyle | int | text Style id. |
| lineStyle | int | line Style id. |
| fillStyle | int | fill Style id. |
autoSpaceShapes(ShapeCollection shapes, AutoSpaceOptions options)
public void autoSpaceShapes(ShapeCollection shapes, AutoSpaceOptions options)
Auto space shapes
Parameters:
| Parameter | Type | Description |
|---|---|---|
| shapes | ShapeCollection | Specifies the shapes be auto spaced. |
| options | AutoSpaceOptions |
bringForward(long shapeId)
public void bringForward(long shapeId)
Brings a shape,defined by ID, forward one position in the z-order.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| shapeId | long | ID of shape.long |
bringToFront(long shapeId)
public void bringToFront(long shapeId)
Brings a shape,defined by ID, to the front of the z-order.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| shapeId | long | ID of shape.long |
centerDrawing()
public void centerDrawing()
Centers a page’s shapes with respect to the extent of the page. Centering shapes does not change their position relative to each other.
connectShapesViaConnector(Shape shapeFrom, int placeFrom, Shape shapeTo, int placeTo, Shape connector)
public void connectShapesViaConnector(Shape shapeFrom, int placeFrom, Shape shapeTo, int placeTo, Shape connector)
Connect shapes via connector.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| shapeFrom | Shape | The shape where the connector begins Shape. |
| placeFrom | int | The location on the first shape where connector will be connected Aspose.Diagram.Manipulation.ConnectionPointPlace. |
| shapeTo | Shape | The shape where the connector ends Shape. |
| placeTo | int | The location on the second shape where connector will be connected Aspose.Diagram.Manipulation.ConnectionPointPlace. |
| connector | Shape | The shape with type Dynamic connector Shape. |
connectShapesViaConnector(long shapeFromId, int placeFrom, long shapeToId, int placeTo, long connectorId)
public void connectShapesViaConnector(long shapeFromId, int placeFrom, long shapeToId, int placeTo, long connectorId)
Connect shapes via connector.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| shapeFromId | long | The ID of shape where the connector begins Shape. |
| placeFrom | int | The location on the first shape where connector will be connected Aspose.Diagram.Manipulation.ConnectionPointPlace. |
| shapeToId | long | The ID of shape where the connector ends Shape. |
| placeTo | int | The location on the second shape where connector will be connected Aspose.Diagram.Manipulation.ConnectionPointPlace. |
| connectorId | long | The ID of shape with type Dynamic connector Shape. |
connectShapesViaConnector(long shapeFromId, String fromConnectionName, long shapeToId, String toConnectionName, long connectorId)
public void connectShapesViaConnector(long shapeFromId, String fromConnectionName, long shapeToId, String toConnectionName, long connectorId)
Connect shapes via connector.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| shapeFromId | long | The ID of shape where the connector begins Shape. |
| fromConnectionName | java.lang.String | The connection name on the first shape where connector will be connected . |
| shapeToId | long | The ID of shape where the connector ends Shape. |
| toConnectionName | java.lang.String | The connection name on the second shape where connector will be connected . |
| connectorId | long | The ID of shape with type Dynamic connector Shape. |
connectShapesViaConnectorIndex(Shape shapeFrom, int fromIndex, Shape shapeTo, int toIndex, Shape connector)
public void connectShapesViaConnectorIndex(Shape shapeFrom, int fromIndex, Shape shapeTo, int toIndex, Shape connector)
Connect shapes via connector index.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| shapeFrom | Shape | The shape where the connector begins Shape. |
| fromIndex | int | The index of the connection on the first shape |
| shapeTo | Shape | The shape where the connector ends Shape. |
| toIndex | int | he index of the connection on the second shape |
| connector | Shape | The shape with type Dynamic connector Shape. |
connectShapesViaConnectorIndex(long shapeFromId, int fromIndex, long shapeToId, int toIndex, long connectorId)
public void connectShapesViaConnectorIndex(long shapeFromId, int fromIndex, long shapeToId, int toIndex, long connectorId)
Connect shapes via connector index.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| shapeFromId | long | The ID of shape where the connector begins Shape. |
| fromIndex | int | The index of the connection on the first shape |
| shapeToId | long | The ID of shape where the connector ends Shape. |
| toIndex | int | he index of the connection on the second shape |
| connectorId | long | The ID of shape with type Dynamic connector Shape. |
copy(Page source)
public void copy(Page source)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| source | Page |
dispose()
public void dispose()
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
drawEllipse(double pinX, double pinY, double width, double height)
public long drawEllipse(double pinX, double pinY, double width, double height)
The process of drawing Ellipse.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| pinX | double | Specifies the x-coordinate of the shape’s pin (center of rotation) in relation to the page. |
| pinY | double | Specifies the y-coordinate of the shape’s pin (center of rotation) in relation to the page. |
| width | double | Specifies the width of the shape |
| height | double | Specifies the height of the shape |
Returns: long -
drawLine(double beginX, double beginY, double endX, double endY)
public long drawLine(double beginX, double beginY, double endX, double endY)
The process of drawing a single line.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| beginX | double | Specifies the begin x-coordinate of the shape’s position in relation to the page. |
| beginY | double | Specifies the begin y-coordinate of the shape’s position in relation to the page. |
| endX | double | Specifies the end x-coordinate of the shape’s position in relation to the page. |
| endY | double | Specifies the end y-coordinate of the shape’s position in relation to the page. |
Returns: long - The unique ID of the shape within shapes collection on the specified page.
drawLine(double pinX, double pinY, double width, double height, double[] xyArray)
public long drawLine(double pinX, double pinY, double width, double height, double[] xyArray)
The process of drawing line.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| pinX | double | Specifies the x-coordinate of the shape’s pin (center of rotation) in relation to the page. |
| pinY | double | Specifies the y-coordinate of the shape’s pin (center of rotation) in relation to the page. |
| width | double | Specifies the width of the shape |
| height | double | Specifies the height of the shape |
| xyArray | double[] | An array of alternating x and y values that defines points in the new shape |
Returns: long - The unique ID of the shape within shapes collection on the specified page.
drawPolyline(double pinX, double pinY, double width, double height, double[] xyArray)
public long drawPolyline(double pinX, double pinY, double width, double height, double[] xyArray)
The process of drawing Polyline.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| pinX | double | Specifies the x-coordinate of the shape’s pin (center of rotation) in relation to the page. |
| pinY | double | Specifies the y-coordinate of the shape’s pin (center of rotation) in relation to the page. |
| width | double | Specifies the width of the shape |
| height | double | Specifies the height of the shape |
| xyArray | double[] | An array of alternating x and y values that defines points in the new shape |
Returns: long - The unique ID of the shape within shapes collection on the specified page.
drawRectangle(double pinX, double pinY, double width, double height)
public long drawRectangle(double pinX, double pinY, double width, double height)
The process of drawing rectangle.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| pinX | double | Specifies the x-coordinate of the shape’s pin (center of rotation) in relation to the page. |
| pinY | double | Specifies the y-coordinate of the shape’s pin (center of rotation) in relation to the page. |
| width | double | Specifies the width of the shape |
| height | double | Specifies the height of the shape |
Returns: long - The unique ID of the shape within shapes collection on the specified page.
equals(Object arg0)
public boolean equals(Object arg0)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | java.lang.Object |
Returns: boolean
getAssociatedPage()
public Page getAssociatedPage()
The ID of the original drawing page that was marked up on separate markup overlays by reviewers of the drawing.
Returns: Page
getBackPage()
public Page getBackPage()
The page’s background page.
Returns: Page
getBackground()
public int getBackground()
A flag indicating if the page is a background page.
Returns: int
getClass()
public final native Class<?> getClass()
Returns: java.lang.Class
getConnects()
public ConnectCollection getConnects()
Contains a Connect element for each connection between two shapes in a drawing.
Returns: ConnectCollection
getID()
public int getID()
The unique ID of the element within its parent element.
Returns: int
getName()
public String getName()
The name of the element.
Returns: java.lang.String
getNameU()
public String getNameU()
The universal name of the element.
Returns: java.lang.String
getPageSheet()
public PageSheet getPageSheet()
Contains elements that define the page sheet for a Page or Master element.
Returns: PageSheet
getPages()
public PageCollection getPages()
Page collection.
Returns: PageCollection
getReviewerID()
public int getReviewerID()
The ID of the reviewer associated with the markup overlay.
Returns: int
getShapes()
public ShapeCollection getShapes()
Shape collection.
Returns: ShapeCollection
getViewCenterX()
public double getViewCenterX()
ViewCenterX and ViewCenterY specify a center point on a page that a new view (window) assumes when it is opened initially.
Returns: double
getViewCenterY()
public double getViewCenterY()
ViewCenterX and ViewCenterY specify a center point on a page that a new view (window) assumes when it is opened initially.
Returns: double
getViewScale()
public double getViewScale()
The default magnification factor to use when a new view (window) of the page is opened. For example, 1 = 100%; 1.5 = 150%, and so on.
Returns: double
glueShapeToConnectorBeginX(long shapeFromId, String connectionName, long connectorId)
public void glueShapeToConnectorBeginX(long shapeFromId, String connectionName, long connectorId)
Glue shape to Connector’s BeginX
Parameters:
| Parameter | Type | Description |
|---|---|---|
| shapeFromId | long | The ID of shape where the connector begins Shape. |
| connectionName | java.lang.String | The connection name on the shape where connector will be connected . |
| connectorId | long | The ID of shape with type Dynamic connector Shape. |
glueShapeToConnectorEndX(long shapeToId, String connectionName, long connectorId)
public void glueShapeToConnectorEndX(long shapeToId, String connectionName, long connectorId)
Glue shape to Connector’s EndX
Parameters:
| Parameter | Type | Description |
|---|---|---|
| shapeToId | long | The ID of shape where the connector ends Shape. |
| connectionName | java.lang.String | The connection name on the second shape where connector will be connected . |
| connectorId | long | The ID of shape with type Dynamic connector Shape. |
glueShapes(Shape shapeFrom, int placeTo, Shape shapeTo)
public void glueShapes(Shape shapeFrom, int placeTo, Shape shapeTo)
Glue shapes.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| shapeFrom | Shape | The shape which is glue from Shape. |
| placeTo | int | The location on the first shape where to glue Aspose.Diagram.Manipulation.ConnectionPointPlace. |
| shapeTo | Shape | The shape where to glue to Shape. |
glueShapes(long shapeFromId, int placeTo, long shapeToId)
public void glueShapes(long shapeFromId, int placeTo, long shapeToId)
Glue shapes
Parameters:
| Parameter | Type | Description |
|---|---|---|
| shapeFromId | long | The ID of shape which is glue from Shape. |
| placeTo | int | The location on the first shape where to glue Aspose.Diagram.Manipulation.ConnectionPointPlace. |
| shapeToId | long | The ID of shape where to glue to Shape. |
glueShapesInContainer(long shapeFromId, int shapeToBeginConnectionIndex, int shapeToEndConnectionIndex, long shapeToId)
public void glueShapesInContainer(long shapeFromId, int shapeToBeginConnectionIndex, int shapeToEndConnectionIndex, long shapeToId)
Glue shapes in container
Parameters:
| Parameter | Type | Description |
|---|---|---|
| shapeFromId | long | The ID of shape which is glue from Shape. |
| shapeToBeginConnectionIndex | int | The location on the first connection index where to glue . |
| shapeToEndConnectionIndex | int | The location on the end connection index where to glue . |
| shapeToId | long | The ID of shape where to glue to Shape. |
glueShapesInContainer(long shapeFromId, String shapeToBeginConnectionName, String shapeToEndConnectionName, long shapeToId)
public void glueShapesInContainer(long shapeFromId, String shapeToBeginConnectionName, String shapeToEndConnectionName, long shapeToId)
Glue shapes in container using connection name
Parameters:
| Parameter | Type | Description |
|---|---|---|
| shapeFromId | long | The ID of shape which is glue from Shape. |
| shapeToBeginConnectionName | java.lang.String | The location on the first connection name where to glue . |
| shapeToEndConnectionName | java.lang.String | The location on the end connection name where to glue . |
| shapeToId | long | The ID of shape where to glue to Shape. |
glueShapesInContainerByID(long shapeFromId, int shapeToBeginConnectionID, int shapeToEndConnectionID, long shapeToId)
public void glueShapesInContainerByID(long shapeFromId, int shapeToBeginConnectionID, int shapeToEndConnectionID, long shapeToId)
Glue shapes by connection id in container
Parameters:
| Parameter | Type | Description |
|---|---|---|
| shapeFromId | long | The ID of shape which is glue from Shape. |
| shapeToBeginConnectionID | int | The location on the first connection id where to glue . |
| shapeToEndConnectionID | int | The location on the end connection id where to glue . |
| shapeToId | long | The ID of shape where to glue to Shape. |
hashCode()
public native int hashCode()
Returns: int
layout(LayoutOptions options)
public void layout(LayoutOptions options)
Lays out the shapes and/or reroutes the connectors for the page.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| options | LayoutOptions | Using the LayoutOptions to configure options of layout. |
moveTo(int index)
public void moveTo(int index)
Moves the page to another location in the pages.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| index | int | Destination page index. |
notify()
public final native void notify()
notifyAll()
public final native void notifyAll()
sendBackward(long shapeId)
public void sendBackward(long shapeId)
Moves a shape,defined by ID, back one position in the z-order.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| shapeId | long | ID of shape.long |
sendToBack(long shapeId)
public void sendToBack(long shapeId)
Moves a shape,defined by ID, to the back of the z-order.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| shapeId | long | ID of shape.long |
setAssociatedPage(Page value)
public void setAssociatedPage(Page value)
For the description of this property, please see getAssociatedPage()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | Page |
setBackPage(Page value)
public void setBackPage(Page value)
For the description of this property, please see getBackPage()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | Page |
setBackground(int value)
public void setBackground(int value)
For the description of this property, please see getBackground()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setID(int value)
public void setID(int value)
For the description of this property, please see getID()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setName(String value)
public void setName(String value)
For the description of this property, please see getName()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setNameU(String value)
public void setNameU(String value)
For the description of this property, please see getNameU()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setPages(PageCollection value)
public void setPages(PageCollection value)
For the description of this property, please see getPages()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | PageCollection |
setPresetTheme(int value)
public void setPresetTheme(int value)
Apply a preset theme to this page
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setPresetThemeQuickStyle(int value)
public void setPresetThemeQuickStyle(int value)
Apply a preset theme variant quickstyle to this page
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setPresetThemeVariant(int value)
public void setPresetThemeVariant(int value)
Apply a preset theme variant to this page
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setReviewerID(int value)
public void setReviewerID(int value)
For the description of this property, please see getReviewerID()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setViewCenterX(double value)
public void setViewCenterX(double value)
For the description of this property, please see getViewCenterX()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | double |
setViewCenterY(double value)
public void setViewCenterY(double value)
For the description of this property, please see getViewCenterY()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | double |
setViewScale(double value)
public void setViewScale(double value)
For the description of this property, please see getViewScale()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | double |
toString()
public String toString()
Returns: java.lang.String
wait()
public final void wait()
wait(long arg0)
public final native void wait(long arg0)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | long |
wait(long arg0, int arg1)
public final void wait(long arg0, int arg1)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | long | |
| arg1 | int |