×Hide private members
+Show private members

GetterSetter

Kind of class:	class
Inherits from:	none
Version:	25 October 2007
Classpath:	GetterSetter
File last modified:	Thursday, 25 October 2007, 23:37:21

► View source

▼ Hide source

/**
* Testing getter and setter methods.
* @version 25 October 2007
*/

class GetterSetter {
    
    private var mA:String;
    private var mB:Number;
    private var mD:String;
    
    /**
    A 'normal' getter and setter. In the documentation the get method and set method are combined as one property.
    */
    public function get a () : Number
    {
        return mX;
    }
    
    public function set a (inValue:Number) : Void
    {
        mX = inValue;
    }
    
    /**
    Illustrates some exceptional (but not impossible) occurrence: get and set method differ in type.
    */
    public function get b () : String
    {
        return mA;
    }
    
    /**
    The setter passes a Number.
    */
    public function set b (inA:Number) : Void
    {
        mA = inA.toString();
    }
    
    /**
    The same as above but in different order (should make no difference in rendering, only in order)
    */
    public function set c (inA:Boolean) : Void
    {
        mA = inA.toString();
    }
    
    // No comment
    public function get c () : Number
    {
        return mA;
    }
    
    /**
    Combining descriptions. This is the getter's comment.
    @todo To do text from the getter.
    */
    public function get d () : String
    {
        return mD;
    }
    
    /**
    Continued comment from setter.
    @todo To do text from the setter.
    */
    public function set d (inD:String) : Void
    {
        mD = inD;
    }
    
    /**
    A method called "set" that is not a property setter.
    @param data Object data
    */
    public function set (data:Object) : Void;

    /**
    A method called "get" that is not a property getter.
    @returns Object data
    */
    public function get () : Object;
    
    /**
     * Setter the vertical alignment of the menu within its bounding box
     */
    [Inspectable(name="Vertical Align", enumeration="top,bottom", defaultValue="top")] 
    public function set verticalAlign(val:String):Void {
        //
    }
    
    /**
     * Setter the horizontal alignment of the menu within its bounding box
     */
    [Inspectable(name="Horizontal Align", type="String", enumeration="left,middle,right", defaultValue="left")]
    [Inspectable("danger", 1, true, maybe)]
     public function set horizontalAlign(val:String):Void {
          //  
    }

}

Testing getter and setter methods.

Summary

Instance properties

mA : String
mB : Number
mD : String
a : Number
- A 'normal' getter and setter.
b : String
- Illustrates some exceptional (but not impossible) occurrence: get and set method differ in type.
b (inA:Number) : Number
- The setter passes a Number.
c (inA:Boolean) : Boolean
- The same as above but in different order (should make no difference in rendering, only in order)
c : Number
d : String
- Combining descriptions.
verticalAlign (val:String) : String
- Setter the vertical alignment of the menu within its bounding box
horizontalAlign (val:String) : String
- Setter the horizontal alignment of the menu within its bounding box

Instance methods

set (data:Object) : Void
- A method called "set" that is not a property setter.
get : Object
- A method called "get" that is not a property getter.

Instance properties

a

a:Number

(read,write)

A 'normal' getter and setter. In the documentation the get method and set method are combined as one property.

b

b:String

(read)

Illustrates some exceptional (but not impossible) occurrence: get and set method differ in type.

b

b:Number

(write)

The setter passes a Number.

c

c:Boolean

(write)

The same as above but in different order (should make no difference in rendering, only in order)

c

c:Number

(read)

d

d:String

(read,write)

Combining descriptions. This is the getter's comment. Continued comment from setter.

To do:

To do text from the getter.
To do text from the setter.

horizontalAlign

horizontalAlign:String

(write)

Setter the horizontal alignment of the menu within its bounding box

Component metadata:

Inspectable	"danger", 1, maybe true, defaultValue: "left" enumeration: "left,middle,right", name: "Horizontal Align", type: "String",

mA

private mA:String

(read)

mB

private mB:Number

(read)

mD

private mD:String

(read)

verticalAlign

verticalAlign:String

(write)

Setter the vertical alignment of the menu within its bounding box

Component metadata:

Inspectable	defaultValue: "top" enumeration: "top,bottom", name: "Vertical Align",

Instance methods

get

function get (

) : Object

A method called "get" that is not a property getter.

Returns:

Object data

set

function set (

data:Object) : Void

A method called "set" that is not a property setter.

Parameters:

data:

Object data