Packagecom.adobe.portfolio.components.supportClasses
Classpublic class FreeFormFields
InheritanceFreeFormFields Inheritance flash.events.EventDispatcher
Implements ICardProperties

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

The FreeFormField class extends EventDispatcher to provide functionality specific to the Freeform navigator.



Public Properties
 PropertyDefined By
  cardHeight : Number
The card's current height
FreeFormFields
  cardWidth : Number
The card's current width
FreeFormFields
  target : GroupBase
The target component
FreeFormFields
  targetSize : Point
[read-only] The width and height of the target
FreeFormFields
Public Methods
 MethodDefined By
  
Constructor.
FreeFormFields
  
getDepth(attachment:IAttachment):Number
Get the depth value from the specified attachment's depth field.
FreeFormFields
  
getLocation(attachment:IAttachment):Point
Get the card layout location for the specified attachment.
FreeFormFields
  
getRotation(attachment:IAttachment):Number
Get the rotation value from the specified attachment's rotation field.
FreeFormFields
  
getX(attachment:IAttachment):Number
Get the x value from the specified attachment's x position field.
FreeFormFields
  
getY(attachment:IAttachment):Number
Get the y value from the specified attachment's y position field.
FreeFormFields
  
isLocationSet(attachment:IAttachment):Boolean
Indicates whether the location of the card for the specified attachment has been set or not.
FreeFormFields
  
setDepth(attachment:IAttachment, value:Number):void
Set the depth value for the specified attachment's depth field.
FreeFormFields
  
setLocation(attachment:IAttachment, value:Point):void
Sets the card layout location for the specified attachment.
FreeFormFields
  
setRotation(attachment:IAttachment, value:Number):void
Sets the rotation of the card layout for the specified attachment
FreeFormFields
  
setX(attachment:IAttachment, value:Number):void
Set the x value for the specified attachment's x position field.
FreeFormFields
  
setY(attachment:IAttachment, value:Number):void
Set the y value for the specified attachment's y position field.
FreeFormFields
Public Constants
 ConstantDefined By
  CARDS_DEPTH : String = adobe:FreeForm:depth
[static] Field name of the pdf file field to get/set the freeform card's depth.
FreeFormFields
  CARDS_ROTATION : String = adobe:FreeForm:angle
[static] Field name of the pdf file field to get/set the freeform card's rotation.
FreeFormFields
  CARDS_X_POS : String = adobe:FreeForm:x
[static] Field name of the pdf file field to get/set the freeform card's x position.
FreeFormFields
  CARDS_Y_POS : String = adobe:FreeForm:y
[static] Field name of the pdf file field to get/set the freeform card's y position.
FreeFormFields
Protected Constants
 ConstantDefined By
  logger : ILogger
[static] The ILogger instance used by this component.
FreeFormFields
Property Detail
cardHeightproperty
cardHeight:Number

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

The card's current height


Implementation
    public function get cardHeight():Number
    public function set cardHeight(value:Number):void
cardWidthproperty 
cardWidth:Number

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

The card's current width


Implementation
    public function get cardWidth():Number
    public function set cardWidth(value:Number):void
targetproperty 
target:GroupBase

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

The target component


Implementation
    public function get target():GroupBase
    public function set target(value:GroupBase):void

See also

spark.components.supportClasses.GroupBase
targetSizeproperty 
targetSize:Point  [read-only]

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

The width and height of the target


Implementation
    public function get targetSize():Point
Constructor Detail
FreeFormFields()Constructor
public function FreeFormFields()

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Constructor.

Method Detail
getDepth()method
public function getDepth(attachment:IAttachment):Number

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Get the depth value from the specified attachment's depth field. If the field has not been set, the default 0 is returned.

Parameters

attachment:IAttachment — The IAttachment for which you want to find the depth of its card layout

Returns
Number — The depth
getLocation()method 
public function getLocation(attachment:IAttachment):Point

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Get the card layout location for the specified attachment.

Parameters

attachment:IAttachment — The IAttachment for which you want to find the layout location

Returns
Point — The layout location of the center of the card given as an ordered pair: (x,y)
getRotation()method 
public function getRotation(attachment:IAttachment):Number

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Get the rotation value from the specified attachment's rotation field. If the field has not been set, the default 0 is returned.

Parameters

attachment:IAttachment — The IAttachment for which you want to find the rotation of its card layout

Returns
Number — The rotation
getX()method 
public function getX(attachment:IAttachment):Number

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Get the x value from the specified attachment's x position field. If the field has not been set, the default 0 is returned.

Parameters

attachment:IAttachment — The IAttachment for which you want to find the x position of its card layout

Returns
Number — The x position
getY()method 
public function getY(attachment:IAttachment):Number

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Get the y value from the specified attachment's y position field. If the field has not been set, the default 0 is returned.

Parameters

attachment:IAttachment — The IAttachment for which you want to find the y position of its card layout

Returns
Number — The y position
isLocationSet()method 
public function isLocationSet(attachment:IAttachment):Boolean

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Indicates whether the location of the card for the specified attachment has been set or not.

Parameters

attachment:IAttachment — The IAttachment for which you want to know if a location has been set for its card

Returns
Booleantrue if the location of the card for the specified IAttachment has been set; returns false if it has not been set
setDepth()method 
public function setDepth(attachment:IAttachment, value:Number):void

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Set the depth value for the specified attachment's depth field.

Parameters

attachment:IAttachment — The IAttachment for which you want to set the depth of its card layout
 
value:Number — The depth

setLocation()method 
public function setLocation(attachment:IAttachment, value:Point):void

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Sets the card layout location for the specified attachment.

Parameters

attachment:IAttachment — The IAttachment for which you want to set the layout location
 
value:Point — The layout location of the center of the card given as an ordered pair: (x,y)

setRotation()method 
public function setRotation(attachment:IAttachment, value:Number):void

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Sets the rotation of the card layout for the specified attachment

Parameters

attachment:IAttachment — The IAttachment for which you want to set the rotation of its card layout
 
value:Number — The rotation of the card layout in degrees of rotation from the horizontal

setX()method 
public function setX(attachment:IAttachment, value:Number):void

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Set the x value for the specified attachment's x position field. The new value is constrained to the target (greater or equal to zero and less than or equal to target width).

Parameters

attachment:IAttachment — The IAttachment for which you want to set the x position of its card layout
 
value:Number — The x position

setY()method 
public function setY(attachment:IAttachment, value:Number):void

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Set the y value for the specified attachment's y position field. The new value is constrained to the target (greater or equal to zero and less than or equal to target height).

Parameters

attachment:IAttachment — The IAttachment for which you want to set the y position of its card layout
 
value:Number — The y position

Constant Detail
CARDS_DEPTHConstant
public static const CARDS_DEPTH:String = adobe:FreeForm:depth

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Field name of the pdf file field to get/set the freeform card's depth.

CARDS_ROTATIONConstant 
public static const CARDS_ROTATION:String = adobe:FreeForm:angle

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Field name of the pdf file field to get/set the freeform card's rotation.

CARDS_X_POSConstant 
public static const CARDS_X_POS:String = adobe:FreeForm:x

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Field name of the pdf file field to get/set the freeform card's x position. The x position is relative to the center of the card.

CARDS_Y_POSConstant 
public static const CARDS_Y_POS:String = adobe:FreeForm:y

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Field name of the pdf file field to get/set the freeform card's y position. The y position is relative to the center of the card.

loggerConstant 
protected static const logger:ILogger

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

The ILogger instance used by this component.