Class: PhpExt_MessageBoxOptions

Source Location: /PhpExt/MessageBoxOptions.php

Class PhpExt_MessageBoxOptions

Class Overview

Located in /PhpExt/MessageBoxOptions.php [line 24]

PhpExt_Object
   |
   --PhpExt_Config_ConfigObject
      |
      --PhpExt_MessageBoxOptions

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From PhpExt_Config_ConfigObject

PhpExt_Config_ConfigObject::$_options

Inherited From PhpExt_Object

PhpExt_Object::$_extClassName

PhpExt_Object::$_extConfigProperties

PhpExt_Object::$_validExtConfigProperties

PhpExt_Object::$_varName

Inherited From PhpExt_Config_ConfigObject

PhpExt_Config_ConfigObject::__construct()

PhpExt_Config_ConfigObject::getJavascript()

Inherited From PhpExt_Object

PhpExt_Object::__construct()

PhpExt_Object::addValidConfigProperties()

PhpExt_Object::createMethodSignature()

PhpExt_Object::getConfigParams()

PhpExt_Object::getExtConfigProperty()

PhpExt_Object::getJavascript()

PhpExt_Object::getMethodInvokeStm()

PhpExt_Object::isExtObject()

PhpExt_Object::paramToString()

PhpExt_Object::setExtClassInfo()

PhpExt_Object::setExtConfigProperty()

PhpExt_Object::__get()

PhpExt_Object::__set()

[ Top ]

Method Summary

static PhpExt_MessageBoxOptions	createMsgOptions()	Helper function to easily create an instance to add configuration properties inline
PhpExt_MessageBoxOptions	__construct()
string\|PhpExt_JavascriptStm	getAnimEl()	An id or Element from which the message box should animate as it opens and closes (defaults to undefined)
PhpExt_JavascriptStm\|array\|bool	getButtons()	A button config object (e.g., PhpExt_MessageBox::OKCANCEL() or {ok:'Foo', cancel:'Bar'}), or false to not show any buttons (defaults to false)
bool	getClosable()	False to hide the top-right close button (defaults to true). Note that progress and wait dialogs will ignore this property and always hide the close button as they can only be closed programmatically.
string	getCssClass()	A custom CSS class to apply to the message box's container element
integer	getDefaultTextHeight()	The default height in pixels of the message box's multiline textarea if displayed (defaults to 75)
PhpExt_JavascriptStm	getFn()	A callback function which is called when the dialog is dismissed either by clicking on the configured buttons, or on the dialog close button, or by pressing the return button to enter input.
string\|PhpExt_JavascriptStm	getIcon()	A CSS class that provides a background image to be used as the body icon for the dialog (e.g., PhpExt_MessageBox::WARNING() or 'custom-class', defaults to '')
string	getIconCssClass()	The standard Ext.Window.iconCls to add an optional header icon (defaults to '')
int	getMaxWidth()	The maximum width in pixels of the message box (defaults to 600)
int	getMinWidth()	The minimum width in pixels of the message box (defaults to 100)
bool	getModal()	False to allow user interaction with the page while the message box is displayed (defaults to true)
string	getMsg()	A string that will replace the existing message box body text (defaults to the XHTML-compliant non-breaking space character ' ')
bool	getMultiline()	True to prompt the user to enter multi-line text (defaults to false)
bool	getProgress()	True to display a progress bar (defaults to false)
string	getProgressText()	The text to display inside the progress bar if progress = true (defaults to '')
bool	getPrompt()	True to prompt the user to enter single-line text (defaults to false)
bool	getProxyDrag()	True to display a lightweight proxy while dragging (defaults to false)
PhpExt_Javascript	getScope()	The scope of the callback function
string	getTitle()	The title text
string	getValue()	The string value to set into the active textbox element if displayed
bool	getWait()	True to display a progress bar (defaults to false)
PhpExt_ProgressBarWaitConfig	getWaitConfig()	A PhpExt_ProgressBarWaitConfig object (applies only if wait = true)
int	getWidth()	The width of the dialog in pixels
PhpExt_MessageBoxOptions	setAnimEl()	An id or Element from which the message box should animate as it opens and closes (defaults to undefined)
PhpExt_MessageBoxOptions	setButtons()	A button config object (e.g., PhpExt_MessageBox::OKCANCEL() or {ok:'Foo', cancel:'Bar'}), or false to not show any buttons (defaults to false)
PhpExt_MessageBoxOptions	setClosable()	False to hide the top-right close button (defaults to true). Note that progress and wait dialogs will ignore this property and always hide the close button as they can only be closed programmatically.
PhpExt_MessageBoxOptions	setCssClass()	A custom CSS class to apply to the message box's container element
PhpExt_MessageBoxOptions	setDefaultTextHeight()	The default height in pixels of the message box's multiline textarea if displayed (defaults to 75)
PhpExt_MessageBoxOptions	setFn()	A callback function which is called when the dialog is dismissed either by clicking on the configured buttons, or on the dialog close button, or by pressing the return button to enter input.
PhpExt_MessageBoxOptions	setIcon()	A CSS class that provides a background image to be used as the body icon for the dialog (e.g., PhpExt_MessageBox::WARNING() or 'custom-class', defaults to '')
PhpExt_MessageBoxOptions	setIconCssClass()	The standard Ext.Window.iconCls to add an optional header icon (defaults to '')
PhpExt_MessageBoxOptions	setMaxWidth()	The maximum width in pixels of the message box (defaults to 600)
PhpExt_MessageBoxOptions	setMinWidth()	The minimum width in pixels of the message box (defaults to 100)
PhpExt_MessageBoxOptions	setModal()	False to allow user interaction with the page while the message box is displayed (defaults to true)
PhpExt_MessageBoxOptions	setMsg()	A string that will replace the existing message box body text (defaults to the XHTML-compliant non-breaking space character ' ')
PhpExt_MessageBoxOptions	setMultiline()	True to prompt the user to enter multi-line text (defaults to false)
PhpExt_MessageBoxOptions	setProgress()	True to display a progress bar (defaults to false)
PhpExt_MessageBoxOptions	setProgressText()	The text to display inside the progress bar if progress = true (defaults to '')
PhpExt_MessageBoxOptions	setPrompt()	True to prompt the user to enter single-line text (defaults to false)
PhpExt_MessageBoxOptions	setProxyDrag()	True to display a lightweight proxy while dragging (defaults to false)
PhpExt_MessageBoxOptions	setScope()	The scope of the callback function
PhpExt_MessageBoxOptions	setTitle()	The title text
PhpExt_MessageBoxOptions	setValue()	The string value to set into the active textbox element if displayed
PhpExt_MessageBoxOptions	setWait()	True to display a progress bar (defaults to false)
PhpExt_MessageBoxOptions	setWaitConfig()	A PhpExt_ProgressBarWaitConfig object (applies only if wait = true)
PhpExt_MessageBoxOptions	setWidth()	The width of the dialog in pixels

[ Top ]

Properties

Methods

static method createMsgOptions [line 497]

static PhpExt_MessageBoxOptions createMsgOptions(
)

Helper function to easily create an instance to add configuration properties inline

API Tags:

Access:

public

[ Top ]

Constructor __construct [line 460]

PhpExt_MessageBoxOptions __construct(
)

API Tags:

Access:

public

Redefinition of:

PhpExt_Config_ConfigObject::__construct()

[ Top ]

getAnimEl [line 41]

string|PhpExt_JavascriptStm getAnimEl(
)

An id or Element from which the message box should animate as it opens and closes (defaults to undefined)

API Tags:

Access:

public

[ Top ]

getButtons [line 59]

PhpExt_JavascriptStm|array|bool getButtons(
)

A button config object (e.g., PhpExt_MessageBox::OKCANCEL() or {ok:'Foo', cancel:'Bar'}), or false to not show any buttons (defaults to false)

API Tags:

Access:

public

[ Top ]

getClosable [line 77]

bool getClosable(
)

False to hide the top-right close button (defaults to true). Note that progress and wait dialogs will ignore this property and always hide the close button as they can only be closed programmatically.

API Tags:

Access:

public

[ Top ]

getCssClass [line 95]

string getCssClass(
)

A custom CSS class to apply to the message box's container element

API Tags:

Access:

public

[ Top ]

getDefaultTextHeight [line 113]

integer getDefaultTextHeight(
)

The default height in pixels of the message box's multiline textarea if displayed (defaults to 75)

API Tags:

Access:

public

[ Top ]

getFn [line 150]

PhpExt_JavascriptStm getFn(
)

A callback function which is called when the dialog is dismissed either by clicking on the configured buttons, or on the dialog close button, or by pressing the return button to enter input.

Progress and wait dialogs will ignore this option since they do not respond to user actions and can only be closed programmatically, so any required function should be called by the same code after it closes the dialog. Parameters passed: <li>buttonId: The ID of the button pressed, one of:

ok
yes
no
cancel

</li> <li>text: Value of input field if prompt or multiline was selected</li>

API Tags:

Access:

public

[ Top ]

getIcon [line 186]

string|PhpExt_JavascriptStm getIcon(
)

A CSS class that provides a background image to be used as the body icon for the dialog (e.g., PhpExt_MessageBox::WARNING() or 'custom-class', defaults to '')

API Tags:

Access:

public

[ Top ]

getIconCssClass [line 204]

string getIconCssClass(
)

The standard Ext.Window.iconCls to add an optional header icon (defaults to '')

API Tags:

Access:

public

[ Top ]

getMaxWidth [line 222]

int getMaxWidth(
)

The maximum width in pixels of the message box (defaults to 600)

API Tags:

Access:

public

[ Top ]

getMinWidth [line 240]

int getMinWidth(
)

The minimum width in pixels of the message box (defaults to 100)

API Tags:

Access:

public

[ Top ]

getModal [line 258]

bool getModal(
)

False to allow user interaction with the page while the message box is displayed (defaults to true)

API Tags:

Access:

public

[ Top ]

getMsg [line 276]

string getMsg(
)

A string that will replace the existing message box body text (defaults to the XHTML-compliant non-breaking space character ' ')

API Tags:

Access:

public

[ Top ]

getMultiline [line 294]

bool getMultiline(
)

True to prompt the user to enter multi-line text (defaults to false)

API Tags:

Access:

public

[ Top ]

getProgress [line 312]

bool getProgress(
)

True to display a progress bar (defaults to false)

API Tags:

Access:

public

[ Top ]

getProgressText [line 330]

string getProgressText(
)

The text to display inside the progress bar if progress = true (defaults to '')

API Tags:

Access:

public

[ Top ]

getPrompt [line 348]

bool getPrompt(
)

True to prompt the user to enter single-line text (defaults to false)

API Tags:

Access:

public

[ Top ]

getProxyDrag [line 366]

bool getProxyDrag(
)

True to display a lightweight proxy while dragging (defaults to false)

API Tags:

Access:

public

[ Top ]

getScope [line 168]

PhpExt_Javascript getScope(
)

The scope of the callback function

API Tags:

Access:

public

[ Top ]

getTitle [line 384]

string getTitle(
)

The title text

API Tags:

Access:

public

[ Top ]

getValue [line 402]

string getValue(
)

The string value to set into the active textbox element if displayed

API Tags:

Access:

public

[ Top ]

getWait [line 420]

bool getWait(
)

True to display a progress bar (defaults to false)

API Tags:

Access:

public

[ Top ]

getWaitConfig [line 438]

PhpExt_ProgressBarWaitConfig getWaitConfig(
)

A PhpExt_ProgressBarWaitConfig object (applies only if wait = true)

API Tags:

Access:

public

[ Top ]

getWidth [line 456]

int getWidth(
)

The width of the dialog in pixels

API Tags:

Access:

public

[ Top ]

setAnimEl [line 33]

PhpExt_MessageBoxOptions setAnimEl(
string|PhpExt_JavascriptStm
$value 
)

An id or Element from which the message box should animate as it opens and closes (defaults to undefined)

Parameters:

string|PhpExt_JavascriptStm

$value:

API Tags:

Access:

public

[ Top ]

setButtons [line 51]

PhpExt_MessageBoxOptions setButtons(
PhpExt_JavascriptStm|array|bool
$value 
)

A button config object (e.g., PhpExt_MessageBox::OKCANCEL() or {ok:'Foo', cancel:'Bar'}), or false to not show any buttons (defaults to false)

Parameters:

PhpExt_JavascriptStm|array|bool

$value:

API Tags:

Access:

public

[ Top ]

setClosable [line 69]

PhpExt_MessageBoxOptions setClosable(
bool
$value 
)

Parameters:

bool

$value:

API Tags:

Access:

public

[ Top ]

setCssClass [line 87]

PhpExt_MessageBoxOptions setCssClass(
string
$value 
)

A custom CSS class to apply to the message box's container element

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setDefaultTextHeight [line 105]

PhpExt_MessageBoxOptions setDefaultTextHeight(
integer
$value 
)

The default height in pixels of the message box's multiline textarea if displayed (defaults to 75)

Parameters:

integer

$value:

API Tags:

Access:

public

[ Top ]

setFn [line 133]

PhpExt_MessageBoxOptions setFn(
PhpExt_JavascriptStm
$value 
)

A callback function which is called when the dialog is dismissed either by clicking on the configured buttons, or on the dialog close button, or by pressing the return button to enter input.

ok
yes
no
cancel

</li> <li>text: Value of input field if prompt or multiline was selected</li>

Parameters:

PhpExt_JavascriptStm

$value:

API Tags:

Access:

public

[ Top ]

setIcon [line 178]

PhpExt_MessageBoxOptions setIcon(
string|PhpExt_JavascriptStm
$value 
)

A CSS class that provides a background image to be used as the body icon for the dialog (e.g., PhpExt_MessageBox::WARNING() or 'custom-class', defaults to '')

Parameters:

string|PhpExt_JavascriptStm

$value:

API Tags:

Access:

public

[ Top ]

setIconCssClass [line 196]

PhpExt_MessageBoxOptions setIconCssClass(
string
$value 
)

The standard Ext.Window.iconCls to add an optional header icon (defaults to '')

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setMaxWidth [line 214]

PhpExt_MessageBoxOptions setMaxWidth(
int
$value 
)

The maximum width in pixels of the message box (defaults to 600)

Parameters:

int

$value:

API Tags:

Access:

public

[ Top ]

setMinWidth [line 232]

PhpExt_MessageBoxOptions setMinWidth(
int
$value 
)

The minimum width in pixels of the message box (defaults to 100)

Parameters:

int

$value:

API Tags:

Access:

public

[ Top ]

setModal [line 250]

PhpExt_MessageBoxOptions setModal(
bool
$value 
)

False to allow user interaction with the page while the message box is displayed (defaults to true)

Parameters:

bool

$value:

API Tags:

Access:

public

[ Top ]

setMsg [line 268]

PhpExt_MessageBoxOptions setMsg(
string
$value 
)

A string that will replace the existing message box body text (defaults to the XHTML-compliant non-breaking space character ' ')

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setMultiline [line 286]

PhpExt_MessageBoxOptions setMultiline(
bool
$value 
)

True to prompt the user to enter multi-line text (defaults to false)

Parameters:

bool

$value:

API Tags:

Access:

public

[ Top ]

setProgress [line 304]

PhpExt_MessageBoxOptions setProgress(
bool
$value 
)

True to display a progress bar (defaults to false)

Parameters:

bool

$value:

API Tags:

Access:

public

[ Top ]

setProgressText [line 322]

PhpExt_MessageBoxOptions setProgressText(
string
$value 
)

The text to display inside the progress bar if progress = true (defaults to '')

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setPrompt [line 340]

PhpExt_MessageBoxOptions setPrompt(
bool
$value 
)

True to prompt the user to enter single-line text (defaults to false)

Parameters:

bool

$value:

API Tags:

Access:

public

[ Top ]

setProxyDrag [line 358]

PhpExt_MessageBoxOptions setProxyDrag(
bool
$value 
)

True to display a lightweight proxy while dragging (defaults to false)

Parameters:

bool

$value:

API Tags:

Access:

public

[ Top ]

setScope [line 160]

PhpExt_MessageBoxOptions setScope(
PhpExt_Javascript
$value 
)

The scope of the callback function

Parameters:

PhpExt_Javascript

$value:

API Tags:

Access:

public

[ Top ]

setTitle [line 376]

PhpExt_MessageBoxOptions setTitle(
string
$value 
)

The title text

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setValue [line 394]

PhpExt_MessageBoxOptions setValue(
string
$value 
)

The string value to set into the active textbox element if displayed

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setWait [line 412]

PhpExt_MessageBoxOptions setWait(
bool
$value 
)

True to display a progress bar (defaults to false)

Parameters:

bool

$value:

API Tags:

Access:

public

[ Top ]

setWaitConfig [line 430]

PhpExt_MessageBoxOptions setWaitConfig(
PhpExt_ProgressBarWaitConfig
$value 
)

A PhpExt_ProgressBarWaitConfig object (applies only if wait = true)

Parameters:

PhpExt_ProgressBarWaitConfig

$value:

API Tags:

Access:

public

[ Top ]

setWidth [line 448]

PhpExt_MessageBoxOptions setWidth(
int
$value 
)

The width of the dialog in pixels

Parameters:

int

$value:

API Tags:

Access:

public

[ Top ]

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