PhpExt : Layout [ class tree ] [ index ] [ all elements ]

Class: PhpExt_Layout_AnchorLayoutData

Source Location: /PhpExt/Layout/AnchorLayoutData.php

Class PhpExt_Layout_AnchorLayoutData

Descendants
Child Class Description
PhpExt_Layout_AbsoluteLayoutData Used when using PhpExt_Layour_AbsoluteLayout as the container's layout.
PhpExt_Layout_FormLayoutData Used when using PhpExt_Layout_FormLayout as the container's layout.

[ Top ]
Method Summary
PhpExt_Layout_AnchorLayoutData   __construct()  
string   getAnchor()   This value is what tells the layout how the item should be anchored to the container. The following types of anchor values are supported:
string   getAnchorSize()   If anchorSize is specifed, the layout will use it as a virtual container for the purposes of calculating anchor measurements based on it instead, allowing the container to be sized independently of the anchoring logic if necessary.
PhpExt_Container   setAnchor()   This value is what tells the layout how the item should be anchored to the container. The following types of anchor values are supported:
PhpExt_Container   setAnchorSize()   If anchorSize is specifed, the layout will use it as a virtual container for the purposes of calculating anchor measurements based on it instead, allowing the container to be sized independently of the anchoring logic if necessary.

[ Top ]
Methods
Constructor __construct  [line 83]

  PhpExt_Layout_AnchorLayoutData __construct( [ $anchor = null], [ $anchorSize = null]  )

Parameters:
   $anchor: 
   $anchorSize: 

API Tags:
Access:  public


Redefinition of:
PhpExt_Layout_ContainerLayoutData::__construct()

Redefined in descendants as:

[ Top ]
getAnchor  [line 58]

  string getAnchor( )

This value is what tells the layout how the item should be anchored to the container. The following types of anchor values are supported:

  • Percentage: Any value between 1 and 100, expressed as a percentage. The first anchor is the percentage width that the item should take up within the container, and the second is the percentage height. Example: '100% 50%' would render an item the complete width of the container and 1/2 its height. If only one anchor value is supplied it is assumed to be the width value and the height will default to auto.
  • Offsets: Any positive or negative integer value. The first anchor is the offset from the right edge of the container, and the second is the offset from the bottom edge. Example: '-50 -100' would render an item the complete width of the container minus 50 pixels and the complete height minus 100 pixels. If only one anchor value is supplied it is assumed to be the right offset value and the bottom offset will default to 0.
  • Sides: Valid values are 'right' (or 'r') and 'bottom' (or 'b'). Either the container must have a fixed size or an anchorSize config value defined at render time in order for these to have any effect.
Anchor values can also be mixed as needed. For example, '-50 75%' would render the width offset from the container right edge by 50 pixels and 75% of the container's height.


API Tags:
See:  PhpExt_Layout_AnchorLayout
Access:  public


[ Top ]
getAnchorSize  [line 78]

  string getAnchorSize( )

If anchorSize is specifed, the layout will use it as a virtual container for the purposes of calculating anchor measurements based on it instead, allowing the container to be sized independently of the anchoring logic if necessary.


API Tags:
See:  PhpExt_Layout_AnchorLayout
Access:  public


[ Top ]
setAnchor  [line 43]

  PhpExt_Container setAnchor( string $value  )

This value is what tells the layout how the item should be anchored to the container. The following types of anchor values are supported:

  • Percentage: Any value between 1 and 100, expressed as a percentage. The first anchor is the percentage width that the item should take up within the container, and the second is the percentage height. Example: '100% 50%' would render an item the complete width of the container and 1/2 its height. If only one anchor value is supplied it is assumed to be the width value and the height will default to auto.
  • Offsets: Any positive or negative integer value. The first anchor is the offset from the right edge of the container, and the second is the offset from the bottom edge. Example: '-50 -100' would render an item the complete width of the container minus 50 pixels and the complete height minus 100 pixels. If only one anchor value is supplied it is assumed to be the right offset value and the bottom offset will default to 0.
  • Sides: Valid values are 'right' (or 'r') and 'bottom' (or 'b'). Either the container must have a fixed size or an anchorSize config value defined at render time in order for these to have any effect.
Anchor values can also be mixed as needed. For example, '-50 75%' would render the width offset from the container right edge by 50 pixels and 75% of the container's height.

Parameters:
string   $value: 

API Tags:
See:  PhpExt_Layout_AnchorLayout
Access:  public


[ Top ]
setAnchorSize  [line 69]

  PhpExt_Container setAnchorSize( string $value  )

If anchorSize is specifed, the layout will use it as a virtual container for the purposes of calculating anchor measurements based on it instead, allowing the container to be sized independently of the anchoring logic if necessary.

Parameters:
string   $value: 

API Tags:
See:  PhpExt_Layout_AnchorLayout
Access:  public


[ Top ]

Documentation generated on Fri, 08 Aug 2008 15:49:56 -0500 by phpDocumentor 1.4.0