Class YAHOO.ext.ContentPanel
A basic ContentPanel element.
Public Properties
This class has no public properties.
Public Methods
|
ContentPanel(String/HTMLElement/Element el , String/Object config , [String content ]) |
ContentPanel |
Create a new ContentPanel. |
|
addListener(String eventName , Function handler , [Object scope ], [boolean override ]) : void |
Observable |
Appends an event handler to this element |
|
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. |
|
destroy() : void |
ContentPanel |
Destroys this panel |
|
fireEvent(String eventName , Object... args ) : void |
Observable |
Fires the specified event with the passed parameters (minus the event name). |
|
getEl() : YAHOO.ext.Element |
ContentPanel |
Returns this panel's element |
|
getId() : String |
ContentPanel |
Returns this panel's id |
|
getTitle() : String |
ContentPanel |
Returns this panel's title |
|
getToolbar() : YAHOO.ext.Toolbar |
ContentPanel |
Returns the toolbar for this Panel if one was configured |
|
getUpdateManager() : YAHOO.ext.UpdateManager |
ContentPanel |
Get the YAHOO.ext.UpdateManager for this panel. Enables you to perform Ajax updates. |
|
isClosable() : Boolean |
ContentPanel |
Returns true is this panel was configured to be closable |
|
purgeListeners() : void |
Observable |
Removes all listeners for this object |
|
removeListener(String eventName , Function handler , [Object scope ]) : void |
Observable |
Removes a listener |
|
setContent(String content , [Boolean loadScripts ]) : void |
ContentPanel |
Updates this panel's element |
|
setTitle(String title ) : void |
ContentPanel |
Set this panel's title |
|
setUrl(String/Function url , [String/Object params ], [Boolean loadOnce ]) : YAHOO.ext.UpdateManager |
ContentPanel |
Set a URL to be used to load the content for this panel. |
Public Events
|
activate : (YAHOO.ext.ContentPanel this ) |
ContentPanel |
Fires when this panel is activated. |
|
deactivate : (YAHOO.ext.ContentPanel this ) |
ContentPanel |
Fires when this panel is activated. |
Constructor Details
ContentPanel
public function ContentPanel(String/HTMLElement/Element el
, String/Object config
, [String content
])
Create a new ContentPanel.
Parameters:
el
: String/HTMLElement/ElementThe container element for this panel
config
: String/ObjectA string to set only the title or a config object
content
: String(optional) Set the HTML content for this panel
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:
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:
destroy
public function destroy()
This method is defined by ContentPanel.
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 this panel's element
This method is defined by ContentPanel.
getId
public function getId()
This method is defined by ContentPanel.
getTitle
public function getTitle()
Returns this panel's title
This method is defined by ContentPanel.
getToolbar
public function getToolbar()
Returns the toolbar for this Panel if one was configured
This method is defined by ContentPanel.
getUpdateManager
public function getUpdateManager()
Get the
YAHOO.ext.UpdateManager for this panel. Enables you to perform Ajax updates.
Parameters:
Returns:
YAHOO.ext.UpdateManager
The UpdateManager
This method is defined by ContentPanel.
isClosable
public function isClosable()
Returns true is this panel was configured to be closable
This method is defined by ContentPanel.
purgeListeners
public function purgeListeners()
Removes all listeners for this object
removeListener
public function removeListener(String eventName
, Function handler
, [Object scope
])
setContent
public function setContent(String content
, [Boolean loadScripts
])
Updates this panel's element
This method is defined by ContentPanel.
setTitle
public function setTitle(String title
)
This method is defined by ContentPanel.
setUrl
public function setUrl(String/Function url
, [String/Object params
], [Boolean loadOnce
])
Set a URL to be used to load the content for this panel.
Parameters:
url
: String/FunctionThe url to load the content from or a function to call to get the url
params
: String/ObjectloadOnce
: Boolean(optional) Whether to only load the content once. If this is false it makes the Ajax call every time this panel is activated. (Defaults to false)
Returns:
YAHOO.ext.UpdateManager
The UpdateManager
This method is defined by ContentPanel.
Event Details
activate
public event activate
Fires when this panel is activated.
Subscribers will be called with the following parameters:
this
: YAHOO.ext.ContentPanel
This event is defined by ContentPanel.
deactivate
public event deactivate
Fires when this panel is activated.
Subscribers will be called with the following parameters:
this
: YAHOO.ext.ContentPanel
This event is defined by ContentPanel.