// Copyright (c) 2008, 2014, Oracle and/or its affiliates. All rights reserved.
/**
* The DvtDiagramLayoutContextLink interface defines the link context for a layout call.
* @export
* @interface DvtDiagramLayoutContextLink
* @memberof oj
*/
/**
* Get the id of the link.
* @method getId
* @instance
* @return {string}
* @memberof oj.DvtDiagramLayoutContextLink
* @export
*/
/**
* Get the id of the start node of this link.
* @method getStartId
* @instance
* @return {string}
* @memberof oj.DvtDiagramLayoutContextLink
* @export
*/
/**
* Get the id of the end node of this link.
* @method getEndId
* @instance
* @return {string}
* @memberof oj.DvtDiagramLayoutContextLink
* @export
*/
/**
* Set the points to use for rendering this link. The given array can contain
* coordinates, like [x1, y1, x2, y2, ..., xn, yn], or SVG path commands, like
* ["M", x1, y1, "L", x2, y2, ..., "L", xn, yn]. The points are in the
* coordinate system of the link's container.
* @method setPoints
* @instance
* @param {array} points array of points to use for rendering this link
* @memberof oj.DvtDiagramLayoutContextLink
* @export
*/
/**
* Get the points to use for rendering this link. The returned array can
* contain coordinates, like [x1, y1, x2, y2, ..., xn, yn], or SVG path
* commands, like ["M", x1, y1, "L", x2, y2, ..., "L", xn, yn]. The points
* are in the coordinate system of the link's container.
* @method getPoints
* @instance
* @return {array}
* @memberof oj.DvtDiagramLayoutContextLink
* @export
*/
/**
* Set the position of the link label. The position is in the coordinate system of the link's container.
* The position represents the upper-left corner for locales with left-to-right reading
* direction and the upper-right corner for locales with right-to-left reading
* direction.
* @method setLabelPosition
* @instance
* @param {Object} pos An object with the following properties for the position of the link label
* @property {number} x x-coordinate
* @property {number} y y-coordinate
* @memberof oj.DvtDiagramLayoutContextLink
* @export
*/
/**
* Get the position of the link label. The position is in the coordinate system of the link's container.
* The position represents the upper-left corner for locales with left-to-right reading
* direction and the upper-right corner for locales with right-to-left reading
* direction.
* @method getLabelPosition
* @instance
* @return {Object} An object with the following properties for the position of the link label
* @property {number} x x-coordinate
* @property {number} y y-coordinate
* @memberof oj.DvtDiagramLayoutContextLink
* @export
*/
/**
* Get the label bounds. The bounds are in the coordinate system of the label.
* @method getLabelBounds
* @instance
* @return {Object} An object with the following properties for the label bound
* @property {number} x x-coordinate
* @property {number} y y-coordinate
* @property {number} w width
* @property {number} h height
* @memberof oj.DvtDiagramLayoutContextLink
* @export
*/
/**
* Get the offset of the start connector. This is the amount of space that the
* link should leave between its starting point and the node for the connector
* to be drawn.
* @method getStartConnectorOffset
* @instance
* @return {number}
* @memberof oj.DvtDiagramLayoutContextLink
* @export
*/
/**
* Get the offset of the end connector. This is the amount of space that the
* link should leave between its ending point and the node for the connector
* to be drawn.
* @method getEndConnectorOffset
* @instance
* @return {number}
* @memberof oj.DvtDiagramLayoutContextLink
* @export
*/
/**
* Get the width of this link.
* @method getLinkWidth
* @instance
* @return {number}
* @memberof oj.DvtDiagramLayoutContextLink
* @export
*/
/**
* Get the corresponding object from the links option array.
* @method getLayoutAttributes
* @instance
* @return {object}
* @memberof oj.DvtDiagramLayoutContextLink
* @export
*/
/**
* Determine whether this link is selected.
* @method getSelected
* @instance
* @return {boolean}
* @memberof oj.DvtDiagramLayoutContextLink
* @export
*/
/**
* Set the angle of rotation of the link label, relative to the label
* rotation point, in radians.
* @method setLabelRotationAngle
* @instance
* @param {number} angle angle of rotation
* @memberof oj.DvtDiagramLayoutContextLink
* @export
*/
/**
* Get the angle of rotation of the link label, relative to the label
* rotation point, in radians.
* @method getLabelRotationAngle
* @instance
* @return {number}
* @memberof oj.DvtDiagramLayoutContextLink
* @export
*/
/**
* Set the point about which to rotate the link label, in the coordinate
* system of the label.
* @method setLabelRotationPoint
* @instance
* @param {Object} point An object with the following properties for the label rotation point
* @property {number} x x-coordinate
* @property {number} y y-coordinate
* @memberof oj.DvtDiagramLayoutContextLink
* @export
*/
/**
* Get the point about which to rotate the link label, in the coordinate
* system of the label.
* @method getLabelRotationPoint
* @instance
* @return {Object} An object with the following properties for the label rotation point
* @property {number} x x-coordinate
* @property {number} y y-coordinate
* @memberof oj.DvtDiagramLayoutContextLink
* @export
*/
Source: 3rdparty/dvt/doc/diagramLayoutAPI/DvtDiagramLayoutContextLink.js
Oracle® JavaScript Extension Toolkit (JET)
1.1.2
E65298-01