public class Page
Constructor Summary |
---|
Page()
Constructor. |
Page(intID)
Constructor. |
Property Getters/Setters Summary | ||
---|---|---|
Page | getAssociatedPage() | |
void | setAssociatedPage(Page value) | |
The ID of the original drawing page that was marked up on separate markup overlays by reviewers of the drawing. | ||
int | getBackground() | |
void | setBackground(intvalue) | |
A flag indicating if the page is a background page. The value of the property is BOOL integer constant. | ||
Page | getBackPage() | |
void | setBackPage(Page value) | |
The page's background page. | ||
ConnectCollection | getConnects() | |
Contains a Connect element for each connection between two shapes in a drawing.
|
||
int | getID() | |
void | setID(intvalue) | |
The unique ID of the element within its parent element. | ||
java.lang.String | getName() | |
void | setName(java.lang.Stringvalue) | |
The name of the element. | ||
java.lang.String | getNameU() | |
void | setNameU(java.lang.Stringvalue) | |
The universal name of the element. | ||
PageCollection | getPages() | |
void | setPages(PageCollection value) | |
Page collection. | ||
PageSheet | getPageSheet() | |
Contains elements that define the page sheet for a Page or Master element.
|
||
void | setPresetTheme(int value) | |
Apply a preset theme to this page
The value of the property is PresetThemeValue integer constant. |
||
void | setPresetThemeQuickStyle(int value) | |
Apply a preset theme variant quickstyle to this page
The value of the property is PresetQuickStyleValue integer constant. |
||
void | setPresetThemeVariant(int value) | |
Apply a preset theme variant to this page
The value of the property is PresetThemeVariantValue integer constant. |
||
int | getReviewerID() | |
void | setReviewerID(intvalue) | |
The ID of the reviewer associated with the markup overlay. | ||
ShapeCollection | getShapes() | |
Shape collection.
|
||
double | getViewCenterX() | |
void | setViewCenterX(doublevalue) | |
ViewCenterX and ViewCenterY specify a center point on a page that a new view (window) assumes when it is opened initially. | ||
double | getViewCenterY() | |
void | setViewCenterY(doublevalue) | |
ViewCenterX and ViewCenterY specify a center point on a page that a new view (window) assumes when it is opened initially. | ||
double | getViewScale() | |
void | setViewScale(doublevalue) | |
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. |
Method Summary | ||
---|---|---|
long | addActiveXControl(int type, double pinX, double pinY, double width, double height) | |
Creates an Activex Control.
|
||
void | addComment(Shape shape, java.lang.String comment) | |
Adds comment to a shape.
|
||
void | addComment(double pinX, double pinY, java.lang.String comment) | |
Adds comment with defined PinX and PinY.
|
||
void | addComment(long shapeID, java.lang.String comment) | |
Adds comment to a shape with shape's id.
|
||
long | addShape(Shape newShape, java.lang.String masterName) | |
Adds shape created by master to specific page.
|
||
long | addShape(double pinX, double pinY, double width, double height, java.lang.String masterName) | |
Adds shape created by master on page with defined PinX,PinY,Width and Height.
|
||
long | addShape(double pinX, double pinY, java.lang.String masterName) | |
Adds shape created by master on page with defined PinX and PinY.
|
||
Shape | addText(double pinX, double pinY, double width, double height, java.lang.String text) | |
Adds Text with defined PinX and PinY.
|
||
Shape | addText(double pinX, double pinY, double width, double height, java.lang.String text, java.lang.String fontName, java.lang.String fontColor, double size) | |
Adds Text with defined PinX and PinY.
|
||
void | applyStyle(int textStyle, int lineStyle, int fillStyle) | |
Applies style for full page.
|
||
void | autoSpaceShapes(ShapeCollection shapes, AutoSpaceOptions options) | |
Auto space shapes
|
||
void | bringForward(long shapeId) | |
Brings a shape,defined by ID, forward one position in the z-order.
|
||
void | bringToFront(long shapeId) | |
Brings a shape,defined by ID, to the front of the z-order.
|
||
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.
|
||
void | connectShapesViaConnector(Shape shapeFrom, int placeFrom, Shape shapeTo, int placeTo, Shape connector) | |
Connect shapes via connector.
|
||
void | connectShapesViaConnector(long shapeFromId, int placeFrom, long shapeToId, int placeTo, long connectorId) | |
Connect shapes via connector.
|
||
void | connectShapesViaConnector(long shapeFromId, java.lang.String fromConnectionName, long shapeToId, java.lang.String toConnectionName, long connectorId) | |
Connect shapes via connector.
|
||
void | connectShapesViaConnectorIndex(Shape shapeFrom, int fromIndex, Shape shapeTo, int toIndex, Shape connector) | |
Connect shapes via connector index.
|
||
void | connectShapesViaConnectorIndex(long shapeFromId, int fromIndex, long shapeToId, int toIndex, long connectorId) | |
Connect shapes via connector index.
|
||
void | copy(Page source) | |
void | dispose() | |
Performs application-defined tasks associated with freeing, releasing, or
resetting unmanaged resources.
|
||
long | drawLine(double beginX, double beginY, double endX, double endY) | |
The process of drawing a single line.
|
||
long | drawRectangle(double pinX, double pinY, double width, double height) | |
The process of drawing rectangle.
|
||
void | glueShapes(Shape shapeFrom, int placeTo, Shape shapeTo) | |
Glue shapes.
|
||
void | glueShapes(long shapeFromId, int placeTo, long shapeToId) | |
Glue shapes
|
||
void | glueShapesInContainer(long shapeFromId, int shapeToBeginConnectionIndex, int shapeToEndConnectionIndex, long shapeToId) | |
Glue shapes in container
|
||
void | glueShapesInContainer(long shapeFromId, java.lang.String shapeToBeginConnectionName, java.lang.String shapeToEndConnectionName, long shapeToId) | |
Glue shapes in container using connection name
|
||
void | glueShapesInContainerByID(long shapeFromId, int shapeToBeginConnectionID, int shapeToEndConnectionID, long shapeToId) | |
Glue shapes by connection id in container
|
||
void | glueShapeToConnectorBeginX(long shapeFromId, java.lang.String connectionName, long connectorId) | |
Glue shape to Connector's BeginX
|
||
void | glueShapeToConnectorEndX(long shapeToId, java.lang.String connectionName, long connectorId) | |
Glue shape to Connector's EndX
|
||
void | layout(LayoutOptions options) | |
Lays out the shapes and/or reroutes the connectors for the page.
|
||
void | moveTo(int index) | |
Moves the page to another location in the pages.
|
||
void | sendBackward(long shapeId) | |
Moves a shape,defined by ID, back one position in the z-order.
|
||
void | sendToBack(long shapeId) | |
Moves a shape,defined by ID, to the back of the z-order.
|
public PageCollection getPages() / public void setPages(PageCollection value)
public ShapeCollection getShapes()
public PageSheet getPageSheet()
public ConnectCollection getConnects()
public int getID() / public void setID(int value)
public java.lang.String getName() / public void setName(java.lang.String value)
public java.lang.String getNameU() / public void setNameU(java.lang.String value)
public int getBackground() / public void setBackground(int value)
public Page getBackPage() / public void setBackPage(Page value)
public double getViewScale() / public void setViewScale(double value)
public double getViewCenterX() / public void setViewCenterX(double value)
public double getViewCenterY() / public void setViewCenterY(double value)
public int getReviewerID() / public void setReviewerID(int value)
public Page getAssociatedPage() / public void setAssociatedPage(Page value)
public void setPresetTheme(int value)
public void setPresetThemeVariant(int value)
public void setPresetThemeQuickStyle(int value)
public void centerDrawing() throws java.lang.Exception
public void copy(Page source) throws java.lang.Exception
public void dispose()
public void applyStyle(int textStyle, int lineStyle, int fillStyle)
textStyle
- text Style id.lineStyle
- line Style id.fillStyle
- fill Style id.public void moveTo(int index)
index
- Destination page index.public long addActiveXControl(int type, double pinX, double pinY, double width, double height) throws java.lang.Exception
type
- A pinX
- Specifies the x-coordinate of the shape's pin (center of rotation) in relation to the page.pinY
- Specifies the y-coordinate of the shape's pin (center of rotation) in relation to the page.width
- Specifies the width of the shape in inches.height
- Specifies the height of the shape in inches.public long addShape(double pinX, double pinY, java.lang.String masterName) throws java.lang.Exception
pinX
- Specifies the x-coordinate of the shape's pin (center of rotation) in relation to the page.pinY
- Specifies the y-coordinate of the shape's pin (center of rotation) in relation to the page.masterName
- Master's name.public long addShape(double pinX, double pinY, double width, double height, java.lang.String masterName) throws java.lang.Exception
pinX
- Specifies the x-coordinate of the shape's pin (center of rotation) in relation to the page.pinY
- Specifies the y-coordinate of the shape's pin (center of rotation) in relation to the page.width
- Specifies the width of the shape in inches.height
- Specifies the height of the shape in inches.masterName
- Master's name.public long addShape(Shape newShape, java.lang.String masterName) throws java.lang.Exception
newShape
- New shape objectmasterName
- Master's name.public void layout(LayoutOptions options) throws java.lang.Exception
options
- Using the public void connectShapesViaConnector(Shape shapeFrom, int placeFrom, Shape shapeTo, int placeTo, Shape connector) throws java.lang.Exception
shapeFrom
- The shape where the connector begins placeFrom
- A shapeTo
- The shape where the connector ends placeTo
- A connector
- The shape with type Dynamic connector public void connectShapesViaConnector(long shapeFromId, int placeFrom, long shapeToId, int placeTo, long connectorId) throws java.lang.Exception
shapeFromId
- The ID of shape where the connector begins placeFrom
- A shapeToId
- The ID of shape where the connector ends placeTo
- A connectorId
- The ID of shape with type Dynamic connector public void connectShapesViaConnector(long shapeFromId, java.lang.String fromConnectionName, long shapeToId, java.lang.String toConnectionName, long connectorId) throws java.lang.Exception
shapeFromId
- The ID of shape where the connector begins fromConnectionName
- The connection name on the first shape where connector will be connected .shapeToId
- The ID of shape where the connector ends toConnectionName
- The connection name on the second shape where connector will be connected .connectorId
- The ID of shape with type Dynamic connector public void glueShapeToConnectorBeginX(long shapeFromId, java.lang.String connectionName, long connectorId) throws java.lang.Exception
public void glueShapeToConnectorEndX(long shapeToId, java.lang.String connectionName, long connectorId) throws java.lang.Exception
public void connectShapesViaConnectorIndex(long shapeFromId, int fromIndex, long shapeToId, int toIndex, long connectorId) throws java.lang.Exception
shapeFromId
- The ID of shape where the connector begins fromIndex
- The index of the connection on the first shapeshapeToId
- The ID of shape where the connector ends toIndex
- he index of the connection on the second shape connectorId
- The ID of shape with type Dynamic connector public void connectShapesViaConnectorIndex(Shape shapeFrom, int fromIndex, Shape shapeTo, int toIndex, Shape connector) throws java.lang.Exception
public void glueShapes(Shape shapeFrom, int placeTo, Shape shapeTo) throws java.lang.Exception
shapeFrom
- The shape which is glue from placeTo
- A shapeTo
- The shape where to glue to public void glueShapes(long shapeFromId, int placeTo, long shapeToId) throws java.lang.Exception
shapeFromId
- The ID of shape which is glue from placeTo
- A shapeToId
- The ID of shape where to glue to public void glueShapesInContainerByID(long shapeFromId, int shapeToBeginConnectionID, int shapeToEndConnectionID, long shapeToId) throws java.lang.Exception
public void glueShapesInContainer(long shapeFromId, java.lang.String shapeToBeginConnectionName, java.lang.String shapeToEndConnectionName, long shapeToId) throws java.lang.Exception
public void glueShapesInContainer(long shapeFromId, int shapeToBeginConnectionIndex, int shapeToEndConnectionIndex, long shapeToId) throws java.lang.Exception
public void bringForward(long shapeId) throws java.lang.Exception
shapeId
- ID of shape.public void sendBackward(long shapeId) throws java.lang.Exception
shapeId
- ID of shape.public void bringToFront(long shapeId) throws java.lang.Exception
shapeId
- ID of shape.public void sendToBack(long shapeId) throws java.lang.Exception
shapeId
- ID of shape.public void addComment(long shapeID, java.lang.String comment)
shape
- The ID of shape which is adding comment.comment
- Comment's string.public void addComment(Shape shape, java.lang.String comment)
shape
- Specifies the shape which is adding comment .comment
- Comment's string.public void addComment(double pinX, double pinY, java.lang.String comment)
pinX
- Specifies the x-coordinate of the comment's pin (center of rotation) in relation to the page.pinY
- Specifies the y-coordinate of the comment's pin (center of rotation) in relation to the page.comment
- Comment's string.public void autoSpaceShapes(ShapeCollection shapes, AutoSpaceOptions options) throws java.lang.Exception
shapes
- Specifies the shapes be auto spaced.public Shape addText(double pinX, double pinY, double width, double height, java.lang.String text, java.lang.String fontName, java.lang.String fontColor, double size)
pinX
- Specifies the x-coordinate of the text's pin (center of rotation) in relation to the page.pinY
- Specifies the y-coordinate of the text's pin (center of rotation) in relation to the page.width
- Specifies the width of the text.height
- Specifies the height of the text.text
- text string.fontName
- text font name.fontColor
- text font color.size
- text font size.public Shape addText(double pinX, double pinY, double width, double height, java.lang.String text)
pinX
- Specifies the x-coordinate of the text's pin (center of rotation) in relation to the page.pinY
- Specifies the y-coordinate of the text's pin (center of rotation) in relation to the page.text
- text string.public long drawLine(double beginX, double beginY, double endX, double endY) throws java.lang.Exception
beginX
- Specifies the begin x-coordinate of the shape's position in relation to the page.beginY
- Specifies the begin y-coordinate of the shape's position in relation to the page.endX
- Specifies the end x-coordinate of the shape's position in relation to the page.endY
- Specifies the end y-coordinate of the shape's position in relation to the page.public long drawRectangle(double pinX, double pinY, double width, double height) throws java.lang.Exception
pinX
- Specifies the x-coordinate of the shape's pin (center of rotation) in relation to the page.pinY
- Specifies the y-coordinate of the shape's pin (center of rotation) in relation to the page.width
- Specifies the width of the shapeheight
- Specifies the height of the shape