Class YAHOO.ext.BasicDialog
Lightweight Dialog Class.
The code below lists all configuration options along with the default value.
If the default value is what you want you can leave it out:
var dlg = new YAHOO.ext.BasicDialog('element-id', {
width: auto,
height: auto,
x: 200, //(defaults to center screen if blank)
y: 500, //(defaults to center screen if blank)
animateTarget: null,// (no animation) This is the id or element to animate from
resizable: true,
minHeight: 80,
minWidth: 200,
modal: false,
autoScroll: true,
closable: true,
constraintoviewport: true,
draggable: true,
autoTabs: false, (if true searches child nodes for elements with class ydlg-tab and converts them to tabs)
proxyDrag: false, (drag a proxy element rather than the dialog itself)
fixedcenter: false,
shadow: false,
minButtonWidth: 75
});
Public Properties
|
body : YAHOO.ext.Element |
BasicDialog |
The body element |
|
footer : YAHOO.ext.Element |
BasicDialog |
The footer element |
|
header : YAHOO.ext.Element |
BasicDialog |
The header element |
Public Methods
|
BasicDialog(String/HTMLElement/YAHOO.ext.Element el , Object config ) |
BasicDialog |
Create a new BasicDialog. |
|
addButton(String/Object config , Function handler , [Object scope ]) : YAHOO.ext.BasicDialog.Button |
BasicDialog |
Adds a button. |
|
addKeyListener(Number/Array/Object key , Function fn , [Object scope ]) : void |
BasicDialog |
Adds a key listener for when this dialog is displayed |
|
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([Boolean removeEl ]) : void |
BasicDialog |
Destroys this dialog |
|
fireEvent(String eventName , Object... args ) : void |
Observable |
Fires the specified event with the passed parameters (minus the event name). |
|
getEl() : YAHOO.ext.BasicDialog |
BasicDialog |
Returns the element for this dialog |
|
getTabs() : YAHOO.ext.TabPanel |
BasicDialog |
Returns the TabPanel component (if autoTabs) |
|
hide([Function callback ]) : void |
BasicDialog |
Hides the dialog. |
|
isVisible() : Boolean |
BasicDialog |
Returns true if the dialog is visible |
|
purgeListeners() : void |
Observable |
Removes all listeners for this object |
|
removeListener(String eventName , Function handler , [Object scope ]) : void |
Observable |
Removes a listener |
|
restoreState() : void |
BasicDialog |
Restores the previous state of the dialog if YAHOO.ext.state is configured |
|
setDefaultButton(YAHOO.ext.BasicDialog.Button btn ) : void |
BasicDialog |
Sets the default button to be focused when the dialog is displayed |
|
show([String/HTMLElement/YAHOO.ext.Element animateTarget ]) : void |
BasicDialog |
Shows the dialog. |
Public Events
|
beforehide : (YAHOO.ext.BasicDialog this ) |
BasicDialog |
Fires before this dialog is hidden. |
|
beforeshow : (YAHOO.ext.BasicDialog this ) |
BasicDialog |
Fires before this dialog is shown. |
|
hide : (YAHOO.ext.BasicDialog this ) |
BasicDialog |
Fires when this dialog is hidden. |
|
keydown : (YAHOO.ext.BasicDialog this , YAHOO.ext.EventObject e ) |
BasicDialog |
Fires when a key is pressed |
|
move : (YAHOO.ext.BasicDialog this , Number x , Number y ) |
BasicDialog |
Fires when this dialog is moved by the user. |
|
resize : (YAHOO.ext.BasicDialog this , Number width , Number height ) |
BasicDialog |
Fires when this dialog is resized by the user. |
|
show : (YAHOO.ext.BasicDialog this ) |
BasicDialog |
Fires when this dialog is shown. |
Property Details
body
public YAHOO.ext.Element body
The body element
This property is defined by BasicDialog.
footer
public YAHOO.ext.Element footer
The footer element
This property is defined by BasicDialog.
header
public YAHOO.ext.Element header
The header element
This property is defined by BasicDialog.
Constructor Details
BasicDialog
public function BasicDialog(String/HTMLElement/YAHOO.ext.Element el
, Object config
)
Create a new BasicDialog.
Method Details
addButton
public function addButton(String/Object config
, Function handler
, [Object scope
])
Adds a button.
Parameters:
config
: String/ObjectA string becomes the button text, an object is expected to be a valid YAHOO.ext.DomHelper element config
handler
: FunctionThe function called when the button is clicked
scope
: Object(optional) The scope of the handler function
Returns:
YAHOO.ext.BasicDialog.Button
This method is defined by BasicDialog.
addKeyListener
public function addKeyListener(Number/Array/Object key
, Function fn
, [Object scope
])
Adds a key listener for when this dialog is displayed
Parameters:
key
: Number/Array/ObjectEither the numeric key code, array of key codes or an object with the following options: {key: (number or array), shift: (true/false), ctrl: (true/false), alt: (true/false)}
fn
: FunctionThe function to call
scope
: Object(optional) The scope of the function
Returns:
This method is defined by BasicDialog.
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([Boolean removeEl
])
This method is defined by BasicDialog.
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 for this dialog
This method is defined by BasicDialog.
getTabs
public function getTabs()
Returns the TabPanel component (if autoTabs)
This method is defined by BasicDialog.
hide
public function hide([Function callback
])
This method is defined by BasicDialog.
isVisible
public function isVisible()
Returns true if the dialog is visible
This method is defined by BasicDialog.
purgeListeners
public function purgeListeners()
Removes all listeners for this object
removeListener
public function removeListener(String eventName
, Function handler
, [Object scope
])
restoreState
public function restoreState()
Restores the previous state of the dialog if YAHOO.ext.state is configured
This method is defined by BasicDialog.
setDefaultButton
public function setDefaultButton(YAHOO.ext.BasicDialog.Button btn
)
Sets the default button to be focused when the dialog is displayed
This method is defined by BasicDialog.
show
public function show([String/HTMLElement/YAHOO.ext.Element animateTarget
])
This method is defined by BasicDialog.
Event Details
beforehide
public event beforehide
Fires before this dialog is hidden.
Subscribers will be called with the following parameters:
this
: YAHOO.ext.BasicDialog
This event is defined by BasicDialog.
beforeshow
public event beforeshow
Fires before this dialog is shown.
Subscribers will be called with the following parameters:
this
: YAHOO.ext.BasicDialog
This event is defined by BasicDialog.
hide
public event hide
Fires when this dialog is hidden.
Subscribers will be called with the following parameters:
this
: YAHOO.ext.BasicDialog
This event is defined by BasicDialog.
keydown
public event keydown
Fires when a key is pressed
Subscribers will be called with the following parameters:
this
: YAHOO.ext.BasicDialoge
: YAHOO.ext.EventObject
This event is defined by BasicDialog.
move
public event move
Fires when this dialog is moved by the user.
Subscribers will be called with the following parameters:
this
: YAHOO.ext.BasicDialogx
: NumberThe new page X
y
: NumberThe new page Y
This event is defined by BasicDialog.
resize
public event resize
Fires when this dialog is resized by the user.
Subscribers will be called with the following parameters:
this
: YAHOO.ext.BasicDialogwidth
: NumberThe new width
height
: NumberThe new height
This event is defined by BasicDialog.
show
public event show
Fires when this dialog is shown.
Subscribers will be called with the following parameters:
this
: YAHOO.ext.BasicDialog
This event is defined by BasicDialog.