StrokeStyle
Defines a stroke line and fill style for a line segment, a curve or a graphics primitive object.
Summary
| StrokeStyle | Defines a stroke line and fill style for a line segment, a curve or a graphics primitive object. |
| Public static constants | |
| maxGradientColors | Maximum number of gradient colors in a fill. |
| Public line properties | |
| width | Line width |
| color | Line color |
| alpha | Line alpha |
| pixelHinting | Line is drawn with pixel hinting |
| scaleMode | Line LineScaleMode enum |
| caps | Line CapsStyle enum |
| joints | Line JointStyle enum |
| miterLimit | Line miter cutoff limit |
| Public fill properties | |
| numFillColors | Number of fill colors (0 is transparent, 1 is solid else 2-6 are gradients) |
| solidFillColor | Solid fill color |
| solidFillAlpha | Solid fill alpha |
| fillType | Gradient fill GradientType enum |
| spread | Gradient fill SpreadMethod enum |
| interpolation | Gradient fill InterpolationMethod enum |
| focalPointRatio | Gradient fill focal point ratio |
| boxWidth | Gradient fill box width |
| boxHeight | Gradient fill box height |
| boxRotation | Gradient fill box rotation |
| boxTx | Gradient fill box X-axis offset |
| boxTy | Gradient fill box Y-axis offset |
| fillColorArray | Array of gradient fill color RGB values |
| fillAlphaArray | Array of gradient fill alphas |
| fillRatioArray | Array of gradient fill distribution ratios |
| Construction/ | |
| StrokeStyle | Creates a stroke style object holding line style and solid or gradient fill properties for a StrokeItem. |
| clone | Returns a deep-copy of the StrokeStyle instance. |
| dispose | Remove resources and references held by this object. |
| Comparison | |
| isStrokeEqual | Compares the line style properties of this StrokeStyle with another instance to see if they are equal. |
| isFillEqual | Compares the fill properties of this StrokeStyle with another instance to see if they are equal. |
| Style manipulation | |
| scale | Scale the width of the line according the requested scaling and the setting of the LineScaleMode property. |
| Reverse engineering | |
| setStyleParams | Sets the line style properties to the given parameters. |
| setFillParams | Sets the solid fill properties to the given parameters. |
| setEndFill | Sets the fill properties to transparent. |
| setGradientParams | Sets the linear or radial gradient fill properties to the given parameters. |
| setBoxParams | Sets the gradient box properties to the given parameters. |
StrokeStyle
public function StrokeStyle( strokeWidth: Number = 1.0, strokeColor: uint = 0x000000, transparency: Number = 1.0, usePixelHinting: Boolean = false, strokeScaleMode: String = "normal", capStyle: String = "round", jointStyle: String = "round", strokeMiterLimit: Number = 3, numColorsInFill: uint = 0, fillColor: uint = 0x000000, fillAlpha: Number = 1.0, gradientType: String = "linear", spreadMethod: String = "pad", interpolationMethod: String = "rgb", focalRatio: Number = 0, gradientBoxWidth: Number = 100, gradientBoxHeight: Number = 100, gradientBoxRotation: Number = 0, gradientBoxTx: Number = 0, gradientBoxTy: Number = 0, fillColors: Array = null, fillAlphas: Array = null, fillRatios: Array = null )
Creates a stroke style object holding line style and solid or gradient fill properties for a StrokeItem.
Initializes gradient fill arrays if they are not given.
Parameters
| strokeWidth | line width |
| strokeColor | line color |
| transparency | line alpha |
| usePixelHinting | line is drawn with pixel hinting |
| strokeScaleMode | line LineScaleMode enum |
| capStyle | line CapsStyle enum |
| jointStyle | line JointStyle enum |
| strokeMiterLimit | line miter cutoff limit |
| numColorsInFill | number of fill colors (0 is transparent, 1 is solid else 2-6 are gradients) |
| fillColor | solid fill color |
| fillAlpha | solid fill alpha |
| gradientType | gradient fill GradientType enum |
| spreadMethod | gradient fill SpreadMethod enum |
| interpolationMethod | gradient fill InterpolationMethod enum |
| focalRatio | gradient fill focal point ratio |
| gradientBoxWidth | gradient fill box width |
| gradientBoxHeight | gradient fill box height |
| gradientBoxRotation | gradient fill box rotation |
| gradientBoxTx | gradient fill box X-axis offset |
| gradientBoxTy | gradient fill box Y-axis offset |
| fillColors | array of gradient fill color RGB values |
| fillAlphas | array of gradient fill alphas |
| fillRatios | array of gradient fill distribution ratios |
clone
public function clone():StrokeStyle
Returns a deep-copy of the StrokeStyle instance.
isStrokeEqual
public function isStrokeEqual( style: StrokeStyle ):Boolean
Compares the line style properties of this StrokeStyle with another instance to see if they are equal.
Parameters
| style | a StrokeStyle object |
Returns
true if equal, false otherwise
isFillEqual
public function isFillEqual( style: StrokeStyle ):Boolean
Compares the fill properties of this StrokeStyle with another instance to see if they are equal.
Parameters
| style | a StrokeStyle object |
Returns
true if equal, false otherwise
setStyleParams
public function setStyleParams( params: Array ):void
Sets the line style properties to the given parameters.
Parameters
| params | array of parameters as obtained from MethodParser.parseParameters |
setFillParams
public function setFillParams( params: Array ):void
Sets the solid fill properties to the given parameters.
Parameters
| params | array of parameters as obtained from MethodParser.parseParameters |
setGradientParams
public function setGradientParams( params: Array ):void
Sets the linear or radial gradient fill properties to the given parameters.
Parameters
| params | array of parameters as obtained from MethodParser.parseParameters |
setBoxParams
public function setBoxParams( params: Array ):void
Sets the gradient box properties to the given parameters.
Parameters
| params | array of parameters as obtained from MethodParser.parseParameters |