Class YAHOO.ext.LayoutManager
Base class for layout managers.
Public Properties
Public Methods
|
addListener(String eventName , Function handler , [Object scope ], [boolean override ]) : void |
Observable |
Appends an event handler to this element |
|
beginUpdate() : void |
LayoutManager |
Suspend the LayoutManager from doing auto-layouts while
making multiple add or remove calls |
|
delayedListener(String eventName , Function handler , [Object scope ], [Number delay ]) : Function |
Observable |
Appends an event handler to this element that is delayed the specified number of milliseconds. |
|
endUpdate(Boolean noLayout ) : void |
LayoutManager |
Restore auto-layouts and optionally disable the manager from performing a layout |
|
fireEvent(String eventName , Object... args ) : void |
Observable |
Fires the specified event with the passed parameters (minus the event name). |
|
getEl() : YAHOO.ext.Element |
LayoutManager |
Returns the element this layout is bound to. |
|
getRegion(String target ) : YAHOO.ext.LayoutRegion |
LayoutManager |
Returns the specified region. |
|
getViewSize() : Object |
LayoutManager |
Returns the size of the current view, This method normalizes document.body and element embedded layouts and
performs ... |
|
isUpdating() : Boolean |
LayoutManager |
Returns true if this layout is currently being updated |
|
purgeListeners() : void |
Observable |
Removes all listeners for this object |
|
removeListener(String eventName , Function handler , [Object scope ]) : void |
Observable |
Removes a listener |
Public Events
|
layout : (YAHOO.ext.LayoutManager this ) |
LayoutManager |
Fires when a layout is performed. |
|
regioncollapsed : (YAHOO.ext.LayoutRegion region ) |
LayoutManager |
Fires when a region is collapsed. |
|
regionexpanded : (YAHOO.ext.LayoutRegion region ) |
LayoutManager |
Fires when a region is expanded. |
|
regionresized : (YAHOO.ext.LayoutRegion region , Number newSize ) |
LayoutManager |
Fires when the user resizes a region. |
Property Details
monitorWindowResize
public Boolean monitorWindowResize
false to disable window resize monitoring
This property is defined by LayoutManager.
Method Details
addListener
public function addListener(String eventName
, Function handler
, [Object scope
], [boolean override
])
Appends an event handler to this element
Parameters:
eventName
: StringThe type of event to listen for
handler
: FunctionThe method the event invokes
scope
: Object(optional) The scope (this object) for the handler
override
: boolean(optional) If true, scope becomes the scope
Returns:
beginUpdate
public function beginUpdate()
Suspend the LayoutManager from doing auto-layouts while
making multiple add or remove calls
This method is defined by LayoutManager.
delayedListener
public function delayedListener(String eventName
, Function handler
, [Object scope
], [Number delay
])
Appends an event handler to this element that is delayed the specified number of milliseconds.
Parameters:
eventName
: StringThe type of event to listen for
handler
: FunctionThe method the event invokes
scope
: Object(optional) The scope (this object) for the handler
delay
: Number(optional) The number of milliseconds to delay
Returns:
endUpdate
public function endUpdate(Boolean noLayout
)
Restore auto-layouts and optionally disable the manager from performing a layout
This method is defined by LayoutManager.
fireEvent
public function fireEvent(String eventName
, Object... args
)
Fires the specified event with the passed parameters (minus the event name).
getEl
public function getEl()
Returns the element this layout is bound to.
This method is defined by LayoutManager.
getRegion
public function getRegion(String target
)
Returns the specified region.
Parameters:
target
: StringThe region key
Returns:
This method is defined by LayoutManager.
getViewSize
public function getViewSize()
Returns the size of the current view, This method normalizes document.body and element embedded layouts and
performs box-model adjustments.
This method is defined by LayoutManager.
isUpdating
public function isUpdating()
Returns true if this layout is currently being updated
This method is defined by LayoutManager.
purgeListeners
public function purgeListeners()
Removes all listeners for this object
removeListener
public function removeListener(String eventName
, Function handler
, [Object scope
])
Event Details
layout
public event layout
Fires when a layout is performed.
Subscribers will be called with the following parameters:
this
: YAHOO.ext.LayoutManager
This event is defined by LayoutManager.
regioncollapsed
public event regioncollapsed
Fires when a region is collapsed.
Subscribers will be called with the following parameters:
region
: YAHOO.ext.LayoutRegion
This event is defined by LayoutManager.
regionexpanded
public event regionexpanded
Fires when a region is expanded.
Subscribers will be called with the following parameters:
region
: YAHOO.ext.LayoutRegion
This event is defined by LayoutManager.
regionresized
public event regionresized
Fires when the user resizes a region.
Subscribers will be called with the following parameters:
This event is defined by LayoutManager.