blob: 14279b8a637169f42dc44a7ebbaeaf19e9a371ea [file] [log] [blame]
{ "type": "class",
"qname": "org.apache.royale.svg.CompoundGraphic",
"baseClassname": "org.apache.royale.svg.GraphicShape"
,
"description": "CompoundGraphic is a surface on which you can draw various graphic elements such as Rect, Circle, Ellipse, Path etc. Use this class if you want to draw multiple graphic shapes on a single container.",
"members": [
{ "type": "accessor",
"access": "read-write",
"return": "org.apache.royale.graphics.IFill",
"qname": "textFill",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "The color of the text.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Royale 0.0"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "org.apache.royale.graphics.IStroke",
"qname": "textStroke",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "The stroke color of the text.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Royale 0.0"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "method",
"qname": "removeAllElements",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Removes all of the drawn elements of the container.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.0.3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "void",
"params": []}
,
{ "type": "method",
"qname": "clear",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Clears all of the drawn path data.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.7.0"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "void",
"params": []}
,
{ "type": "method",
"qname": "drawRect",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Draw the rectangle.",
"tags": [
{ "tagName": "param",
"values": ["x The x position of the top-left corner of the rectangle.", "y The y position of the top-left corner.", "width The width of the rectangle.", "height The height of the rectangle."]},
{ "tagName": "playerversion",
"values": ["Flash 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.0.3"]},
{ "tagName": "royaleignorecoercion",
"values": ["org.apache.royale.core.WrappedHTMLElement"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "void",
"params": [{ "name": "x", "type": "Number"},
{ "name": "y", "type": "Number"},
{ "name": "width", "type": "Number"},
{ "name": "height", "type": "Number"}]}
,
{ "type": "method",
"qname": "drawRoundRect",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Draws a rounded rectangle. Note: The radius values are different than the Flash API of the same name. Flash uses diameter instead of radius.",
"tags": [
{ "tagName": "param",
"values": ["x The x position of the top-left corner of the rectangle.", "y The y position of the top-left corner.", "width The width of the rectangle.", "height The height of the rectangle.", "radiusX The horizontal radius of the rounded corners (in pixels).", "radiusY The vertical radius of the rounded corners (in pixels). Optional; if no value is specified, the default value matches that provided for the <code>radiusX</code> parameter."]},
{ "tagName": "playerversion",
"values": ["Flash 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.0.3"]},
{ "tagName": "royaleignorecoercion",
"values": ["org.apache.royale.core.WrappedHTMLElement"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "void",
"params": [{ "name": "x", "type": "Number"},
{ "name": "y", "type": "Number"},
{ "name": "width", "type": "Number"},
{ "name": "height", "type": "Number"},
{ "name": "radiusX", "type": "Number"},
{ "name": "radiusY", "type": "Number"}]}
,
{ "type": "method",
"qname": "drawEllipse",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Draw the ellipse.",
"tags": [
{ "tagName": "param",
"values": ["x The x position of the top-left corner of the bounding box of the ellipse.", "y The y position of the top-left corner of the bounding box of the ellipse.", "width The width of the ellipse.", "height The height of the ellipse."]},
{ "tagName": "playerversion",
"values": ["Flash 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.0.3"]},
{ "tagName": "royaleignorecoercion",
"values": ["org.apache.royale.core.WrappedHTMLElement"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "void",
"params": [{ "name": "x", "type": "Number"},
{ "name": "y", "type": "Number"},
{ "name": "width", "type": "Number"},
{ "name": "height", "type": "Number"}]}
,
{ "type": "method",
"qname": "drawCircle",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Draw the circle.",
"tags": [
{ "tagName": "param",
"values": ["x The x location of the center of the circle", "y The y location of the center of the circle.", "radius The radius of the circle."]},
{ "tagName": "playerversion",
"values": ["Flash 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.0"]},
{ "tagName": "royaleignorecoercion",
"values": ["org.apache.royale.core.WrappedHTMLElement"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "void",
"params": [{ "name": "x", "type": "Number"},
{ "name": "y", "type": "Number"},
{ "name": "radius", "type": "Number"}]}
,
{ "type": "method",
"qname": "drawPathCommands",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Draw the path.",
"tags": [
{ "tagName": "param",
"values": ["data A PathBuilder object containing a vector of drawing commands."]},
{ "tagName": "playerversion",
"values": ["Flash 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.0"]},
{ "tagName": "royaleignorecoercion",
"values": ["org.apache.royale.core.WrappedHTMLElement"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "void",
"params": [{ "name": "data", "type": "org.apache.royale.graphics.PathBuilder"}]}
,
{ "type": "method",
"qname": "drawStringPath",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Draw the path. The value is a space-delimited string describing each path segment. Each segment entry has a single character which denotes the segment type and two or more segment parameters. If the segment command is upper-case, the parameters are absolute values. If the segment command is lower-case, the parameters are relative values.",
"tags": [
{ "tagName": "param",
"values": ["data A string containing a compact represention of the path segments."]},
{ "tagName": "playerversion",
"values": ["Flash 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.0"]},
{ "tagName": "royaleignorecoercion",
"values": ["org.apache.royale.core.WrappedHTMLElement"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "void",
"params": [{ "name": "data", "type": "String"}]}
,
{ "type": "method",
"qname": "drawLine",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"return": "void",
"params": []}
,
{ "type": "method",
"qname": "drawPolygon",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"return": "void",
"params": []}
,
{ "type": "method",
"qname": "drawRoundRectComplex",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Draws a rounded rectangle using the size of a radius to draw the rounded corners. You must set the line style, fill, or both on the Graphics object before you call the <code>drawRoundRectComplex()</code> method by calling the <code>linestyle()</code>, <code>lineGradientStyle()</code>, <code>beginFill()</code>, <code>beginGradientFill()</code>, or <code>beginBitmapFill()</code> method. registration point of the parent display object, in pixels. registration point of the parent display object, in pixels.",
"tags": [
{ "tagName": "param",
"values": ["graphics The Graphics object that draws the rounded rectangle.", "x The horizontal position relative to the", "y The vertical position relative to the", "width The width of the round rectangle, in pixels.", "height The height of the round rectangle, in pixels.", "topLeftRadius The radius of the upper-left corner, in pixels.", "topRightRadius The radius of the upper-right corner, in pixels.", "bottomLeftRadius The radius of the bottom-left corner, in pixels.", "bottomRightRadius The radius of the bottom-right corner, in pixels."]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Royale 1.0.0"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "void",
"params": [{ "name": "x", "type": "Number"},
{ "name": "y", "type": "Number"},
{ "name": "width", "type": "Number"},
{ "name": "height", "type": "Number"},
{ "name": "topLeftRadius", "type": "Number"},
{ "name": "topRightRadius", "type": "Number"},
{ "name": "bottomLeftRadius", "type": "Number"},
{ "name": "bottomRightRadius", "type": "Number"}]}
,
{ "type": "method",
"qname": "drawRoundRectComplex2",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Draws a rounded rectangle using the size of individual x and y radii to draw the rounded corners. You must set the line style, fill, or both on the Graphics object before you call the <code>drawRoundRectComplex2()</code> method by calling the <code>linestyle()</code>, <code>lineGradientStyle()</code>, <code>beginFill()</code>, <code>beginGradientFill()</code>, or <code>beginBitmapFill()</code> method. registration point of the parent display object, in pixels. registration point of the parent display object, in pixels. This value must be specified. If 0, the value of radiusX is used. the value of radiusX is used. the value of topLeftRadiusX is used. the value of radiusX is used. the value of topRightRadiusX is used. the value of radiusX is used. the value of bottomLeftRadiusX is used. the value of radiusX is used. the value of bottomRightRadiusX is used.",
"tags": [
{ "tagName": "param",
"values": ["graphics The Graphics object that draws the rounded rectangle.", "x The horizontal position relative to the", "y The vertical position relative to the", "width The width of the round rectangle, in pixels.", "height The height of the round rectangle, in pixels.", "radiusX The default radiusX to use, if corner-specific values are not specified.", "radiusY The default radiusY to use, if corner-specific values are not specified.", "topLeftRadiusX The x radius of the upper-left corner, in pixels. If NaN,", "topLeftRadiusY The y radius of the upper-left corner, in pixels. If NaN,", "topRightRadiusX The x radius of the upper-right corner, in pixels. If NaN,", "topRightRadiusY The y radius of the upper-right corner, in pixels. If NaN,", "bottomLeftRadiusX The x radius of the bottom-left corner, in pixels. If NaN,", "bottomLeftRadiusY The y radius of the bottom-left corner, in pixels. If NaN,", "bottomRightRadiusX The x radius of the bottom-right corner, in pixels. If NaN,", "bottomRightRadiusY The y radius of the bottom-right corner, in pixels. If NaN,"]},
{ "tagName": "playerversion",
"values": ["Flash 10", "AIR 1.5"]},
{ "tagName": "productversion",
"values": ["Royale 1.0.0"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "void",
"params": [{ "name": "x", "type": "Number"},
{ "name": "y", "type": "Number"},
{ "name": "width", "type": "Number"},
{ "name": "height", "type": "Number"},
{ "name": "radiusX", "type": "Number"},
{ "name": "radiusY", "type": "Number"},
{ "name": "topLeftRadiusX", "type": "Number"},
{ "name": "topLeftRadiusY", "type": "Number"},
{ "name": "topRightRadiusX", "type": "Number"},
{ "name": "topRightRadiusY", "type": "Number"},
{ "name": "bottomLeftRadiusX", "type": "Number"},
{ "name": "bottomLeftRadiusY", "type": "Number"},
{ "name": "bottomRightRadiusX", "type": "Number"},
{ "name": "bottomRightRadiusY", "type": "Number"}]}
,
{ "type": "method",
"qname": "drawText",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Draw a string of characters.",
"tags": [
{ "tagName": "param",
"values": ["value The string to draw.", "x The x location of the center of the circle", "y The y location of the center of the circle."]},
{ "tagName": "playerversion",
"values": ["Flash 10.2", "AIR 2.6"]},
{ "tagName": "productversion",
"values": ["Royale 0.0"]},
{ "tagName": "royaleignorecoercion",
"values": ["org.apache.royale.core.WrappedHTMLElement", "Node"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "Object",
"params": [{ "name": "value", "type": "String"},
{ "name": "x", "type": "Number"},
{ "name": "y", "type": "Number"}]}
,
{ "type": "method",
"qname": "getTxtStyleStr",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "return",
"values": ["{string} The style attribute."]} ],
"return": "String",
"params": []}
,
{ "type": "method",
"qname": "addElementToSurface",
"namespace": "protected",
"bindable": [],
"details": [],
"deprecated": {},
"return": "void",
"params": [{ "name": "e", "type": "org.apache.royale.core.WrappedHTMLElement"}]}
]
}