Packageorg.igniterealtime.xiff.data.whiteboard
Classpublic class Stroke
InheritanceStroke Inheritance XMLStanza Inheritance ExtensionContainer Inheritance Object
Implements INodeProxy

A helper class that abstracts the serialization of strokes and provides an interface to access the properties



Public Properties
 PropertyDefined By
  color : uint
The value of the RGB color.
Stroke
  opacity : Number
The opacity of the stroke, in percent.
Stroke
  thickness : Number
The thickness of the stroke in pixels.
Stroke
 Inheritedxml : XML
The XML node that should be used for this stanza's internal XML representation, base of the XMLStanza, XML element.
ExtensionContainer
Public Methods
 MethodDefined By
  
Stroke(color:uint = 0, opacity:Number = 100, thickness:Number)
Stroke
 Inherited
Add extension to the list of the given namespace and insert to the XML element as a child.
ExtensionContainer
 Inherited
ExtensionContainer
 Inherited
getAllExtensionsByNS(nameSpace:String):Array
ExtensionContainer
 Inherited
getAttribute(name:String):String
Convinience method for getting element value from the XML.
XMLStanza
 Inherited
getChildAttribute(elem:String, name:String):String
Convinience method for getting child element attribute value from the XML.
XMLStanza
 Inherited
getChildField(elem:String, name:String):String
Convinience method for getting child element value from the XML.
XMLStanza
 Inherited
getExtension(elementName:String):IExtension
Get the extension having the given element name.
ExtensionContainer
 Inherited
getField(name:String):String
Convinience method for getting element value from the XML.
XMLStanza
 Inherited
removeAllExtensions(nameSpace:String):void
ExtensionContainer
 Inherited
removeExtension(extension:IExtension):Boolean
ExtensionContainer
 Inherited
removeFields(name:String):void
Helper method for removing all child elements that have the given name.
XMLStanza
 Inherited
setAttribute(name:String, value:String):void
Convinience method for setting a value to a element in the XML.
XMLStanza
 Inherited
setChildAttribute(elem:String, name:String, value:String):void
Convinience method for setting an attribute for a child element of the XML.
XMLStanza
 Inherited
setChildField(elem:String, name:String, value:String):void
Convinience method for setting a value for a child element of the XML.
XMLStanza
 Inherited
setField(name:String, value:String):void
Convinience method for setting a value to a element in the XML.
XMLStanza
 Inherited
toString():String
Converts the base stanza XML to a string.
XMLStanza
Public Constants
 ConstantDefined By
 InheritedDEFAULT_NS : Namespace
[static] Default XML namespace.
XMLStanza
  ELEMENT_NAME : String = stroke
[static]
Stroke
 InheritedFLASH_NS : Namespace
[static]
XMLStanza
 InheritedSTREAM_NS : Namespace
[static]
XMLStanza
Property Detail
colorproperty
color:uint

The value of the RGB color. This is the same color format used by Graphics.lineStyle

XML attribute "stroke"


Implementation
    public function get color():uint
    public function set color(value:uint):void

See also

opacityproperty 
opacity:Number

The opacity of the stroke, in percent. 100 is solid, 0 is transparent. This property can be used as the alpha parameter of Graphics.lineStyle

XML attribute "stroke-opacity"


Implementation
    public function get opacity():Number
    public function set opacity(value:Number):void

See also

thicknessproperty 
thickness:Number

The thickness of the stroke in pixels. This is in a format used by Graphics.lineStyle

XML attribute "stroke-width"


Implementation
    public function get thickness():Number
    public function set thickness(value:Number):void

See also

Constructor Detail
Stroke()Constructor
public function Stroke(color:uint = 0, opacity:Number = 100, thickness:Number)

Parameters
color:uint (default = 0)
 
opacity:Number (default = 100)
 
thickness:Number (default = NaN)
Constant Detail
ELEMENT_NAMEConstant
public static const ELEMENT_NAME:String = stroke