Class: PromptService

Source Location: /class/windows.php.inc

Class Overview

Node
   |
   --PromptService

OS-native prompt service object

property:	bool $result: Whether the dialog was accepted by the user (e.g. clicked OK)
property:	bool $checkState: State of the checkbox (if any)
property:	mixed $value: Value of the textbox or selected item in the list
property:	string $username: Supplied username
property:	string $password: Supplied password

Author(s):

Constants

Variables

Methods

Inherited Variables

Class: Node

Node::$eventHandler
Node::$eventType
Node::$eventYielder
Node::$handlerFor
Node::$id
Node::$isChild
Node::$isRegistered
Node::$parent
Node::$rootApplication
Node::$rootWindow
Node::$yielderFor

Inherited Methods

Class: Node

Node::__construct(): Dynamic Constructor
Node::accessKey(): Set the accessKey attribute for this element
Node::align(): Set the align attribute for this element
Node::attach(): [INTERNAL FUNCTION] Default attach method
Node::attributeMethod(): Convenient attribute setter
Node::backgroundColor(): Set the background color for the element
Node::backgroundImage(): Set the background of a node using CSS background-image property
Node::blur(): Make this node loose focus
Node::callMethod(): Call a JavaScript method on the client-side node
Node::callMethodDelayed(): Call a JavaScript method on the client-side node in a delayed fashion
Node::className(): Set the CSS classname for the element
Node::commandHandler(): [INTERNAL FUNCTION] Handles an incoming event for this node
Node::context(): Set a contextmenu to show when clicking the context (right) mouse or keyboard button on this element
Node::createClientEvent(): Creates a new event on the client side
Node::createRemoteObject(): [INTERNAL FUNCTION] Calls the remote constructor of this class
Node::crop(): Set the crop attribute for this element
Node::detach(): [INTERNAL FUNCTION] Default detach method
Node::disabled(): Set the disabled attribute for this element
Node::equalsize(): Set the equalsize attribute for this element
Node::extractNode(): Extracts this node and its childnodes
Node::findAncestor(): Return the first ancestor of a certain class of this node
Node::fireClientEvent(): Fires a remote (client) event
Node::fireLocalEvent(): Fires a local (server) event
Node::flex(): Set the flex attribute for this element
Node::focus(): Give this node focus
Node::height(): Set the height of the element
Node::hidden(): Set the hidden attribute for this element
Node::initNodeLayout(): [INTERNAL FUNCTION] Initializes the attributes of a node when it is registered
Node::insertElement(): [INTERNAL FUNCTION] Inserts the newly constructed node's element into the DOM tree on the client side
Node::label(): Set the label attribute for this element
Node::margin(): Set the margin of the element
Node::marginBottom(): Set the bottom margin of the element
Node::marginLeft(): Set the left margin of the element
Node::marginRight(): Set the right margin of the element
Node::marginTop(): Set the top margin of the element
Node::mousethrough(): Indicate whether mouse events should pass through this node onto its parent
Node::orient(): Set the orient attribute for this element
Node::pack(): Set the pack attribute for this element
Node::padding(): Set the padding of the element
Node::paddingBottom(): Set the bottom padding of the element
Node::paddingLeft(): Set the left padding of the element
Node::paddingRight(): Set the right padding of the element
Node::paddingTop(): Set the top padding of the element
Node::popup(): Set a popup menu to show when clicking on this element
Node::removeAttribute(): Remove an attribute on the client-side XUL node
Node::removeElement(): [INTERNAL FUNCTION] Removes the node's element from the client DOM tree
Node::removeEventHandler(): Removes an event handler
Node::removeEventReflex(): Removes a previously set reflex for a certain event
Node::removeEventYielder(): Removed a node this is yielded when an event on this node fires
Node::removeNode(): Removes and unregisters this node and its childnodes
Node::setAttribute(): Set an attribute on the client-side XUL node
Node::setDraggable(): Set this element as draggable
Node::setDroppable(): Set this element as a dropzone
Node::setEvent(): Shorthand version for setEventType, setEventHandler and setEventYielder
Node::setEventBlocking(): Sets whether the event should block (be synchronous)
Node::setEventHandler(): Sets an event handler
Node::setEventReflex(): Sets a reflex for a certain event
Node::setEventType(): Sets the event type for a certain event
Node::setEventYielder(): Sets a node to yield when an event on this node fires
Node::setMethod(): Set a JavaScript method on the client-side node
Node::setProperty(): Set a JavaScript property on the client-side node
Node::setStyle(): Set a CSS style property on the client-side XUL node
Node::size(): Set the size of the element
Node::textColor(): Set the text color for the element
Node::textSize(): Set the text size for the element
Node::textStyle(): Set the text style for the element
Node::tooltip(): Set a tooltip to show when hovering over this element
Node::tooltiptext(): Set the tooltiptext attribute for this element
Node::unbind(): [INTERNAL FUNCTION] Removes links to child and parent nodes
Node::unlink(): [INTERNAL FUNCTION] Removes event handler and yielder links to other nodes
Node::unRegister(): [INTERNAL FUNCTION] Removes this node from the client registry
Node::value(): Set the value attribute for this element
Node::width(): Set the width of the element
Node::yield(): Manually yield this node
Node::_dropHandler()

Class Variables

$promptInProgress = FALSE

access:

public

Type:

mixed

$remoteConstructor = 'PromptService'

access:

public

Type:

mixed

Class Methods

method alert() [line 507]

void alert(
string
$title, string
$text)

Shows a alert box with an OK button

access:

public

Parameters:

string	$title	Title of the dialog box
string	$text	Body text

[ Top ]

method alertCheck() [line 524]

void alertCheck(
string
$title, string
$text, string
$checkMsg, bool
$checkState, object
$handlerObj, string
$handlerMethod, [mixed
$carryValue = NULL])

Shows an alert box with an OK button and a checkbox

access:

public

Parameters:

string	$title	Title of the dialog box
string	$text	Body text
string	$checkMsg	Label text of the checkbox
bool	$checkState	Initial state of the checkbox
object	$handlerObj	Object to call the handler method on
string	$handlerMethod	Method to call on the handler object
mixed	$carryValue	Arbitrary value to pass on to the handler function

[ Top ]

method attach() [line 494]

void attach(
)

access:

public

Overrides Node::attach() ([INTERNAL FUNCTION] Default attach method)

[ Top ]

method confirm() [line 544]

void confirm(
string
$title, string
$text, object
$handlerObj, string
$handlerMethod, [mixed
$carryValue = NULL])

Shows a confirm box with OK and Cancel buttons

access:

public

Parameters:

string	$title	Title of the dialog box
string	$text	Body text
object	$handlerObj	Object to call the handler method on
string	$handlerMethod	Method to call on the handler object
mixed	$carryValue	Arbitrary value to pass on to the handler function

[ Top ]

method confirmCheck() [line 565]

void confirmCheck(
string
$title, string
$text, string
$checkMsg, bool
$checkState, object
$handlerObj, string
$handlerMethod, [mixed
$carryValue = NULL])

Shows a confirm box with OK and Cancel buttons and a checkbox

access:

public

Parameters:

string	$title	Title of the dialog box
string	$text	Body text
string	$checkMsg	Label text of the checkbox
bool	$checkState	Initial state of the checkbox
object	$handlerObj	Object to call the handler method on
string	$handlerMethod	Method to call on the handler object
mixed	$carryValue	Arbitrary value to pass on to the handler function

[ Top ]

method confirmEx() [line 593]

void confirmEx(
string
$title, string
$text, int
$buttonFlags, string
$button0Title, string
$button1Title, string
$button2Title, string
$checkMsg, bool
$checkState, object
$handlerObj, string
$handlerMethod, [mixed
$carryValue = NULL])

Shows a custom confirm box with up to three buttons and a checkbox

link:	example
access:	public

Parameters:

string	$title	Title of the dialog box
string	$text	Body text
int	$buttonFlags	Button flags
string	$button0Title	Optional custom title for button 0
string	$button1Title	Optional custom title for button 1
string	$button2Title	Optional custom title for button 2
string	$checkMsg	Label text of the checkbox
bool	$checkState	Initial state of the checkbox
object	$handlerObj	Object to call the handler method on
string	$handlerMethod	Method to call on the handler object
mixed	$carryValue	Arbitrary value to pass on to the handler function

[ Top ]

method prompt() [line 614]

void prompt(
string
$title, string
$text, string
$textValue, object
$handlerObj, string
$handlerMethod, [mixed
$carryValue = NULL])

Shows a prompt box with a textinput and OK and Cancel buttons

access:

public

Parameters:

string	$title	Title of the dialog box
string	$text	Body text
string	$textValue	Initial value of the textinput
object	$handlerObj	Object to call the handler method on
string	$handlerMethod	Method to call on the handler object
mixed	$carryValue	Arbitrary value to pass on to the handler function

[ Top ]

method promptCheck() [line 637]

void promptCheck(
string
$title, string
$text, string
$textValue, string
$checkMsg, bool
$checkState, object
$handlerObj, string
$handlerMethod, [mixed
$carryValue = NULL])

Shows a prompt box with a textinput, a checkbox and OK and Cancel buttons

access:

public

Parameters:

string	$title	Title of the dialog box
string	$text	Body text
string	$textValue	Initial value of the textinput
string	$checkMsg	Label text of the checkbox
bool	$checkState	Initial state of the checkbox
object	$handlerObj	Object to call the handler method on
string	$handlerMethod	Method to call on the handler object
mixed	$carryValue	Arbitrary value to pass on to the handler function

[ Top ]

method promptPassword() [line 704]

void promptPassword(
string
$title, string
$text, string
$password, object
$handlerObj, string
$handlerMethod, [mixed
$carryValue = NULL])

Shows a prompt box with a password textinput and OK and Cancel buttons

access:

public

Parameters:

string	$title	Title of the dialog box
string	$text	Body text
string	$password	Initial value of the password textinput
object	$handlerObj	Object to call the handler method on
string	$handlerMethod	Method to call on the handler object
mixed	$carryValue	Arbitrary value to pass on to the handler function

[ Top ]

method promptPasswordCheck() [line 727]

void promptPasswordCheck(
string
$title, string
$text, string
$password, string
$checkMsg, bool
$checkState, object
$handlerObj, string
$handlerMethod, [mixed
$carryValue = NULL])

Shows a prompt box with a password textinput, a checkbox and OK and Cancel buttons

access:

public

Parameters:

string	$title	Title of the dialog box
string	$text	Body text
string	$password	Initial value of the password textinput
string	$checkMsg	Label text of the checkbox
bool	$checkState	Initial state of the checkbox
object	$handlerObj	Object to call the handler method on
string	$handlerMethod	Method to call on the handler object
mixed	$carryValue	Arbitrary value to pass on to the handler function

[ Top ]

method promptUsernameAndPassword() [line 659]

void promptUsernameAndPassword(
string
$title, string
$text, string
$username, string
$password, object
$handlerObj, string
$handlerMethod, [mixed
$carryValue = NULL])

Shows a prompt box with username and password textinputs and OK and Cancel buttons

access:

public

Parameters:

string	$title	Title of the dialog box
string	$text	Body text
string	$username	Initial value of the username textinput
string	$password	Initial value of the password textinput
object	$handlerObj	Object to call the handler method on
string	$handlerMethod	Method to call on the handler object
mixed	$carryValue	Arbitrary value to pass on to the handler function

[ Top ]

method promptUsernameAndPasswordCheck() [line 683]

void promptUsernameAndPasswordCheck(
string
$title, string
$text, string
$username, string
$password, string
$checkMsg, bool
$checkState, object
$handlerObj, string
$handlerMethod, [mixed
$carryValue = NULL])

Shows a prompt box with username and password textinputs, a checkbox and OK and Cancel buttons

access:

public

Parameters:

string	$title	Title of the dialog box
string	$text	Body text
string	$username	Initial value of the username textinput
string	$password	Initial value of the password textinput
string	$checkMsg	Label text of the checkbox
bool	$checkState	Initial state of the checkbox
object	$handlerObj	Object to call the handler method on
string	$handlerMethod	Method to call on the handler object
mixed	$carryValue	Arbitrary value to pass on to the handler function

[ Top ]

method select() [line 749]

void select(
string
$title, string
$text, array
$list, int
$selectedIndex, object
$handlerObj, string
$handlerMethod, [mixed
$carryValue = NULL])

Shows a prompt box with a dropdown box and OK and Cancel buttons

access:

public

Parameters:

string	$title	Title of the dialog box
string	$text	Body text
array	$list	Array of options (strings)
int	$selectedIndex	Initial index to select (broken)
object	$handlerObj	Object to call the handler method on
string	$handlerMethod	Method to call on the handler object
mixed	$carryValue	Arbitrary value to pass on to the handler function

[ Top ]

method yieldCollect() [line 763]

void yieldCollect(

$e, 
$result, 
$checkState, 
$value, 
$username, 
$password)

[INTERNAL FUNCTION] Collects the results of a prompt

access:

public

Parameters:

	$e
	$result
	$checkState
	$value
	$username
	$password

[ Top ]

Class Constants

BUTTON_DELAY_ENABLE = 67108864

[line 483]

[ Top ]

BUTTON_POS_0 = 1

[line 465]

[ Top ]

BUTTON_POS_0_DEFAULT = 0

[line 479]

[ Top ]

BUTTON_POS_1 = 256

[line 466]

[ Top ]

BUTTON_POS_1_DEFAULT = 16777216

[line 480]

[ Top ]

BUTTON_POS_2 = 65536

[line 467]

[ Top ]

BUTTON_POS_2_DEFAULT = 33554432

[line 481]

[ Top ]

BUTTON_TITLE_CANCEL = 2

[line 471]

[ Top ]

BUTTON_TITLE_DONT_SAVE = 6

[line 475]

[ Top ]

BUTTON_TITLE_IS_STRING = 127

[line 477]

[ Top ]

BUTTON_TITLE_NO = 4

[line 473]

[ Top ]

BUTTON_TITLE_OK = 1

[line 470]

[ Top ]

BUTTON_TITLE_REVERT = 7

[line 476]

[ Top ]

BUTTON_TITLE_SAVE = 5

[line 474]

[ Top ]

BUTTON_TITLE_YES = 3

[line 472]

[ Top ]

STD_OK_CANCEL_BUTTONS = 513

[line 484]

[ Top ]

STD_YES_NO_BUTTONS = 1027

[line 485]

[ Top ]

Documentation generated on Tue, 10 May 2011 19:43:13 +0200 by phpDocumentor 1.4.3

Packages

API

Classes

Files

Class: PromptService

Class Overview

Author(s):

Constants

Variables

Methods

Inherited Variables

Class: Node

Inherited Methods

Class: Node

Class Variables

$promptInProgress = FALSE

$remoteConstructor = 'PromptService'

Class Methods

method alert() [line 507]

Parameters:

method alertCheck() [line 524]

Parameters:

method attach() [line 494]

method confirm() [line 544]

Parameters:

method confirmCheck() [line 565]

Parameters:

method confirmEx() [line 593]

Parameters:

method prompt() [line 614]

Parameters:

method promptCheck() [line 637]

Parameters:

method promptPassword() [line 704]

Parameters:

method promptPasswordCheck() [line 727]

Parameters:

method promptUsernameAndPassword() [line 659]

Parameters:

method promptUsernameAndPasswordCheck() [line 683]

Parameters:

method select() [line 749]

Parameters:

method yieldCollect() [line 763]

Parameters:

Class Constants

BUTTON_DELAY_ENABLE = 67108864

BUTTON_POS_0 = 1

BUTTON_POS_0_DEFAULT = 0

BUTTON_POS_1 = 256

BUTTON_POS_1_DEFAULT = 16777216

BUTTON_POS_2 = 65536

BUTTON_POS_2_DEFAULT = 33554432

BUTTON_TITLE_CANCEL = 2

BUTTON_TITLE_DONT_SAVE = 6

BUTTON_TITLE_IS_STRING = 127

BUTTON_TITLE_NO = 4

BUTTON_TITLE_OK = 1

BUTTON_TITLE_REVERT = 7

BUTTON_TITLE_SAVE = 5

BUTTON_TITLE_YES = 3

STD_OK_CANCEL_BUTTONS = 513

STD_YES_NO_BUTTONS = 1027