Class: Window

Source Location: /forms.inc.php

Class Overview

Object
   |
   --Persistent
      |
      --Component
         |
         --Control
            |
            --FocusControl
               |
               --QWidget
                  |
                  --Window

A class to encapsulate a window living on the browser

Author(s):

Variables

Methods

Inherited Variables

Inherited Methods

Class: QWidget

QWidget::__construct()
QWidget::addOtherChildren(): Override this method to add more childrens to a qwidget parent, useful if your component is built by more than one component
QWidget::dumpChildrenControls(): Code to dump when the Widget accepts children controls.
QWidget::dumpCommonContentsBottom(): Dump common qooxdoo finalization code
QWidget::dumpCommonContentsTop(): Dump the common qooxdoo initialization code
QWidget::dumpCommonQWidgetJSEvents(): This function uses PrepareQWJSEvent to dump the attachment for common javascript events
QWidget::dumpCommonQWidgetProperties(): Dumps to the output the code to set common properties, like enabled, font, color, etc.
QWidget::dumpHeaderCode()
QWidget::getHidden()
QWidget::PrepareQWJSEvent(): Dumps code to add an event for the widget
QWidget::setHidden()

Class: FocusControl

FocusControl::__construct()
FocusControl::dumpChildren(): Dumps all children iterating through the Controls property and calls the show method of each one.
FocusControl::readControlCount(): Returns the number of controls for which this control is the Parent.
FocusControl::readLayout(): Specifies the Layout this control uses to render its controls to the browser.
FocusControl::updateChildrenColors(): Updates the colors for all the children if parentcolor is set.
FocusControl::updateChildrenFonts(): If this control has any children that have ParentFont==true, then this function will assign the same Font property to all children Font properties.
FocusControl::updateChildrenParentProperties(): Updates all necessary properties for any children that use property values from their parent.
FocusControl::updateChildrenShowHints(): Updates the ShowHints properties for all children controls.
FocusControl::writeLayout()

Class: Control

Control::__construct(): Constructor for the class
Control::addJSWrapperToEvents(): Adds or replaces the JS event attribute with the wrapper.
Control::beginCache()
Control::canShow(): Determines whether a control can be shown or not.
Control::defaultAdjustToLayout()
Control::defaultAlign()
Control::defaultAlignment()
Control::defaultAttributes()
Control::defaultAutosize()
Control::defaultCached()
Control::defaultCaption()
Control::defaultColor()
Control::defaultCursor()
Control::defaultDesignColor()
Control::defaultDivWrap()
Control::defaultEnabled()
Control::defaultHeight()
Control::defaultHidden()
Control::defaultHint()
Control::defaultIsLayer()
Control::defaultjsOnActivate()
Control::defaultjsOnBeforeCopy()
Control::defaultjsOnBeforeCut()
Control::defaultjsOnBeforeDeactivate()
Control::defaultjsOnBeforeEditfocus()
Control::defaultjsOnBeforePaste()
Control::defaultjsOnBlur()
Control::defaultjsOnChange()
Control::defaultjsOnClick()
Control::defaultjsOnContextMenu()
Control::defaultjsOnControlSelect()
Control::defaultjsOnCopy()
Control::defaultjsOnCut()
Control::defaultjsOnDblClick()
Control::defaultjsOnDeActivate()
Control::defaultjsOnDrag()
Control::defaultjsOnDragEnter()
Control::defaultjsOnDragLeave()
Control::defaultjsOnDragOver()
Control::defaultjsOnDragStart()
Control::defaultjsOnDrop()
Control::defaultjsOnFilterChange()
Control::defaultjsOnFocus()
Control::defaultjsOnHelp()
Control::defaultjsOnKeyDown()
Control::defaultjsOnKeyPress()
Control::defaultjsOnKeyUp()
Control::defaultjsOnLoseCapture()
Control::defaultjsOnMouseDown()
Control::defaultjsOnMouseEnter()
Control::defaultjsOnMouseLeave()
Control::defaultjsOnMouseMove()
Control::defaultjsOnMouseOut()
Control::defaultjsOnMouseOver()
Control::defaultjsOnMouseUp()
Control::defaultjsOnPaste()
Control::defaultjsOnPropertyChange()
Control::defaultjsOnReadyStateChange()
Control::defaultjsOnResize()
Control::defaultjsOnResizeEnd()
Control::defaultjsOnResizeStart()
Control::defaultjsOnSelectStart()
Control::defaultLayer()
Control::defaultLeft()
Control::defaultOnAfterShow()
Control::defaultOnBeforeShow()
Control::defaultOnShow()
Control::defaultParentColor()
Control::defaultParentFont()
Control::defaultParentShowHint()
Control::defaultPopupmenu()
Control::defaultShowHint()
Control::defaultStyle()
Control::defaultTop()
Control::defaultVisible()
Control::defaultWidth()
Control::dumpChildren(): Dumps all children components.
Control::dumpContents(): Dumps the control contents.
Control::dumpHeaderCode(): Dumps the component header code.
Control::dumpJavascript(): Dumps all required javascript code for the component.
Control::dumpJsEvents(): Dumps all assigned javascript events code.
Control::endCache()
Control::getCached()
Control::getCursor(): Change the value of Cursor to provide feedback to the user when the mouse pointer enters the control.
Control::getHeight(): Specifies the vertical size of the control or form in pixels.
Control::getHint(): Specifies the text to show in a tooltip when the mouse is over the control for some time.
Control::getHintAttribute(): If control has any Hint, then returns the hint in attribute format for the tag.
Control::getJSWrapperFunction(): JS wrapper function that forwards a JS event to the PHP script by submitting the HTML form.
Control::getJSWrapperFunctionName(): Gets the function name of a JS event wrapper.
Control::getLayer(): Determines the layer in which this control is going to be rendered.
Control::getLeft(): Uses the Left property to determine where the left side of the control begins, or to reposition the left side of the control.
Control::getOnAfterShow(): Fires the Event after showing the control.
Control::getOnBeforeShow(): Fires the Event before showing the control.
Control::getOnShow(): Fires the Event at the same moment the control is shown. Some controls can prevent the control from being shown when this event is attached.
Control::getTop(): Uses Top to locate the top of the control, or reposition the control to a different Y coordinate.
Control::getWidth(): Specifies the horizontal size of the control or form in pixels.
Control::init()
Control::loaded()
Control::readAdjustToLayout(): A helper property for Layouts to know if the component should adjust to the layout or not
Control::readAlign(): Determines how the control aligns within its container (parent control).
Control::readAlignment(): Specifies the alignment to be used by the control, it depends on the control on how to use this property to show information.
Control::readAttributes(): A property for tag based controls to allow component user to add attributes to the tag
Control::readAutosize(): Determines if the control is going to adjust itself to the parent size
Control::readCaption(): Specifies a text string that identifies the control to the user.
Control::readColor(): Specifies the main color of the control.
Control::readControlStyle(): An array which holds the control style, with settings for the IDE.
Control::readDesignColor(): Specifies a color to use by the control at design time.
Control::readDivWrap(): Specifies if the control must be wrapped by a div or not
Control::readDoParentReset(): Performs a parent reset if true.
Control::readEnabled(): Controls whether the control responds to mouse, keyboard, and timer events.
Control::readFont(): Determines the Font to be used when generating this control.
Control::readHidden(): This property, when true, allows controls to generate all code, but don't show the control on the browser.
Control::readIsLayer(): Specifies if this control is a Layer instead of being integrated into the document.
Control::readJsEvents(): Returns a string with all assigned javascript events, ready to be added to a control tag.
Control::readjsOnActivate(): Fires when the object is set as the active element.
Control::readjsOnBeforeCopy(): Fires on the source object before the selection is copied to the system clipboard.
Control::readjsOnBeforeCut(): Fires on the source object before the selection is deleted from the document.
Control::readjsOnBeforeDeactivate(): Fires immediately before the activeElement is changed from the current object to another object in the parent document.
Control::readjsOnBeforeEditfocus(): Fires before an object contained in an editable element enters a UI-activated state or when an editable container object is control selected.
Control::readjsOnBeforePaste(): Fires on the target object before the selection is pasted from the system clipboard to the document.
Control::readjsOnBlur(): Fires when the object loses the input focus.
Control::readjsOnChange(): Fires when the contents of the object or selection have changed.
Control::readjsOnClick(): Fires when the user clicks the left mouse button on the object.
Control::readjsOnContextMenu(): Fires when the user clicks the right mouse button in the client area, opening the context menu.
Control::readjsOnControlSelect(): Fires when the user is about to make a control selection of the object.
Control::readjsOnCopy(): Fires on the source element when the user copies the object or selection, adding it to the system clipboard.
Control::readjsOnCut(): Fires on the source element when the object or selection is removed from the document and added to the system clipboard.
Control::readjsOnDblClick(): Fires when the user double-clicks the object.
Control::readjsOnDeActivate(): Fires when the activeElement is changed from the current object to another object in the parent document.
Control::readjsOnDrag(): Fires on the source object continuously during a drag operation.
Control::readjsOnDragEnter(): Fires on the target element when the user drags the object to a valid drop target.
Control::readjsOnDragLeave(): Fires on the target object when the user moves the mouse out of a valid drop target during a drag operation.
Control::readjsOnDragOver(): Fires on the target element continuously while the user drags the object over a valid drop target.
Control::readjsOnDragStart(): Fires on the source object when the user starts to drag a text selection or selected object.
Control::readjsOnDrop(): Fires on the target object when the mouse button is released during a drag-and-drop operation.
Control::readjsOnFilterChange(): Fires when a visual filter changes state or completes a transition.
Control::readjsOnFocus(): Fires when the object receives focus.
Control::readjsOnHelp(): Fires when the user presses the F1 key while the browser is the active window.
Control::readjsOnKeyDown(): Fires when the user presses a key.
Control::readjsOnKeyPress(): Fires when the user presses an alphanumeric key.
Control::readjsOnKeyUp(): Fires when the user releases a key.
Control::readjsOnLoseCapture(): Fires when the object loses the mouse capture.
Control::readjsOnMouseDown(): Fires when the user clicks the object with either mouse button.
Control::readjsOnMouseEnter(): Fires when the user moves the mouse pointer into the object.
Control::readjsOnMouseLeave(): Fires when the user moves the mouse pointer outside the boundaries of the object.
Control::readjsOnMouseMove(): Fires when the user moves the mouse over the object.
Control::readjsOnMouseOut(): Fires when the user moves the mouse pointer outside the boundaries of the object.
Control::readjsOnMouseOver(): Fires when the user moves the mouse pointer into the object.
Control::readjsOnMouseUp(): Fires when the user releases a mouse button while the mouse is over the object.
Control::readjsOnPaste(): Fires on the target object when the user pastes data, transferring the data from the system clipboard to the document.
Control::readjsOnPropertyChange(): Fires when a property changes on the object.
Control::readjsOnReadyStateChange(): Fires when the state of the object has changed.
Control::readjsOnResize(): Fires when the size of the object is about to change.
Control::readjsOnResizeEnd(): Fires when the user finishes changing the dimensions of the object in a control selection.
Control::readjsOnResizeStart(): Fires when the user begins to change the dimensions of the object in a control selection
Control::readjsOnSelectStart(): Fires when the object is being selected
Control::readJSWrapperHiddenFieldName(): Gets the name of the hidden field used to submit the value for the event that was fired.
Control::readJSWrapperSubmitEventValue(): Sets the value to the hidden field when the specific JS event was fired and the wrapper function was called.
Control::readParent(): Indicates the parent of the control.
Control::readParentColor(): Determines where a control looks for its color information.
Control::readParentFont(): Determines where a control looks for its font information.
Control::readParentShowHint(): Determines where a control looks to find out if its Help Hint should be shown.
Control::readPopupMenu(): Identifies the pop-up menu associated with the control.
Control::readShowHint(): Determines whether the control displays a Help Hint when the mouse pointer rests momentarily on the control.
Control::readStyle(): Use this property to attach a css style to the control.
Control::readStyleClass(): Normalizes the css style class name
Control::readVisible(): Determines whether the component appears on the browser.
Control::setCached()
Control::setCursor()
Control::setHeight()
Control::setHint()
Control::setLayer()
Control::setLeft()
Control::setOnAfterShow()
Control::setOnBeforeShow()
Control::setOnShow()
Control::setTop()
Control::setWidth()
Control::show(): Dumps the code for the control to the output.
Control::updateParentColor(): If ParentColor == true the parent's color is assigned to this control.
Control::updateParentFont(): If ParentFont == true the parent's font is assigned to this control.
Control::updateParentProperties(): Updates all properties that use the parent property as source.
Control::updateParentShowHint(): If ParentShowHint == true the parent's showhint is assigned to this control.
Control::writeAdjustToLayout()
Control::writeAlign()
Control::writeAlignment()
Control::writeAttributes()
Control::writeAutosize()
Control::writeCaption()
Control::writeColor()
Control::writeControlStyle()
Control::writeDesignColor()
Control::writeDivWrap()
Control::writeEnabled()
Control::writeFont()
Control::writeHidden()
Control::writeIsLayer()
Control::writejsOnActivate()
Control::writejsOnBeforeCopy()
Control::writejsOnBeforeCut()
Control::writejsOnBeforeDeactivate()
Control::writejsOnBeforeEditfocus()
Control::writejsOnBeforePaste()
Control::writejsOnBlur()
Control::writejsOnChange()
Control::writejsOnClick()
Control::writejsOnContextMenu()
Control::writejsOnControlSelect()
Control::writejsOnCopy()
Control::writejsOnCut()
Control::writejsOnDblClick()
Control::writejsOnDeActivate()
Control::writejsOnDrag()
Control::writejsOnDragEnter()
Control::writejsOnDragLeave()
Control::writejsOnDragOver()
Control::writejsOnDragStart()
Control::writejsOnDrop()
Control::writejsOnFilterChange()
Control::writejsOnFocus()
Control::writejsOnHelp()
Control::writejsOnKeyDown()
Control::writejsOnKeyPress()
Control::writejsOnKeyUp()
Control::writejsOnLoseCapture()
Control::writejsOnMouseDown()
Control::writejsOnMouseEnter()
Control::writejsOnMouseLeave()
Control::writejsOnMouseMove()
Control::writejsOnMouseOut()
Control::writejsOnMouseOver()
Control::writejsOnMouseUp()
Control::writejsOnPaste()
Control::writejsOnPropertyChange()
Control::writejsOnReadyStateChange()
Control::writejsOnResize()
Control::writejsOnResizeEnd()
Control::writejsOnResizeStart()
Control::writejsOnSelectStart()
Control::writeParent()
Control::writeParentColor()
Control::writeParentFont()
Control::writeParentShowHint()
Control::writePopupMenu()
Control::writeShowHint()
Control::writeStyle()
Control::writeVisible()

Class: Component

Component::__construct(): Component constructor
Component::ajaxCall(): Dumps the javascript code to make an ajax call to the server.
Component::callEvent(): Calls a server event.
Component::defaultName()
Component::defaultTag()
Component::dumpChildrenFormItems(): This method is called by the page just after dumping the starting form tag.
Component::dumpChildrenHeaderCode(): Dumps the header code for all the children
Component::dumpChildrenJavascript(): Dumps the javascript code for all the children
Component::dumpFormItems(): Dumps code just after the form tag, useful to dump hidden fields for state retrieving for non visible components
Component::dumpHeaderCode(): Dumps header code required
Component::dumpHiddenKeyFields(): Dumps hidden field values for the key record
Component::dumpJavascript(): Dumps the javascript code needed by this component
Component::dumpJSEvent(): Dumps javascript code for an event
Component::fixupProperty(): Resolves the right reference to an object property
Component::generateAjaxEvent(): Returns the javascript code to generate an ajax call.
Component::getName(): Specifies the name for the component. The name is used as an identifier and should be unique.
Component::getTag(): A versatile property of every Component that can be used in any way you want
Component::hasValidDataField(): Returns true if a valid data field is attached to the component
Component::init(): Initializes a component
Component::insertComponent(): Inserts a component into the component's collection
Component::loaded(): Initializes the component after the form file has been read into memory.
Component::loadedChildren(): Calls childrens loaded
Component::loadResource(): Loads this component from a string
Component::preinit(): Method called before init()
Component::readAccessibility(): Provides accessibility info to the embedded RPC engine.
Component::readComponentCount(): Indicates the number of components owned by the component.
Component::readComponents(): Lists all the components owned by this component.
Component::readControlState(): A flag to know the state of the control, csLoading, csDesigning
Component::readDataFieldValue(): This property returns the value of the datafield if any.
Component::readFromResource(): Reads a component from a resource file
Component::readNamePath(): Specifies the path to uniquely identify a component, qualified by the owner when required.
Component::readOwner(): Indicates the component that is responsible for streaming and freeing this component.
Component::removeComponent(): Removes a component from the component's collection
Component::serializeChildren(): Serializes all children
Component::setName()
Component::setTag()
Component::unserializeChildren(): Unserializes all children by calling unserialize for all the components
Component::updateDataField(): Updates the field on the dataset attached, if any
Component::writeControlState()

Class: Persistent

Persistent::allowserialize(): This method provides an opportunity for the component developer to prevent the serialization/unserialization of a property.
Persistent::assign(): Assigns the source properties to this object.
Persistent::assignError(): Raises an assignation error.
Persistent::assignTo(): Assigns this object to another object.
Persistent::inSession(): This method determines if this object exists in the current session.
Persistent::readNamePath(): Used to serialize/unserialize. It returns the full path to identify this component.
Persistent::readOwner(): Owner of the component.
Persistent::serialize(): Stores this object into the session.
Persistent::unserialize(): This method uses PHP reflection to iterate through published properties (the ones starting with get) and retrieve the properties stored by a previous serialize() call.

Class: Object

Object::__construct(): Constructs an object and initializes its data before the object is first used.
Object::className(): Returns a string indicating the type of the object instance (as opposed to the type of the variable passed as an argument).
Object::classNameIs(): Determines whether an object is of a specific type.
Object::classParent(): Returns the type of the immediate ancestor of a class.
Object::inheritsFrom(): Determines the relationship of two object types.
Object::methodExists(): Check if a method exists declared on this object instance.
Object::readProperty(): Reads a property from the streams
Object::__get(): To virtualize properties
Object::__set(): To virtualize properties

Class Details

[line 399]
A class to encapsulate a window living on the browser

This component allows you to place a window inside a browser, mimmicking a desktop window, so you can place components inside to give your application a more desktop-like interface.

Tags:

example:	example not found
example:	example not found

[ Top ]

Class Variables

$_iconsource = ""

[line 622]

Tags:

access:

protected

Type:

mixed

[ Top ]

$_isvisible = true

[line 427]

Tags:

access:

protected

Type:

mixed

[ Top ]

$_jsonclose = null

[line 691]

Tags:

access:

protected

Type:

mixed

[ Top ]

$_jsonmaximize = null

[line 675]

Tags:

access:

protected

Type:

mixed

[ Top ]

$_jsonminimize = null

[line 643]

Tags:

access:

protected

Type:

mixed

[ Top ]

$_jsonmove = null

[line 706]

Tags:

access:

protected

Type:

mixed

[ Top ]

$_jsonresize = null

[line 720]

Tags:

access:

protected

Type:	mixed
Overrides:	Array

[ Top ]

$_jsonrestore = null

[line 659]

Tags:

access:

protected

Type:

mixed

[ Top ]

$_modal = 0

[line 409]

Tags:

access:

protected

Type:

mixed

[ Top ]

$_moveable = 1

[line 461]

Tags:

access:

protected

Type:

mixed

[ Top ]

$_movemethod = "mmOpaque"

[line 567]

Tags:

access:

protected

Type:

mixed

[ Top ]

$_resizeable = 1

[line 445]

Tags:

access:

protected

Type:

mixed

[ Top ]

$_resizemethod = "rmFrame"

[line 586]

Tags:

access:

protected

Type:

mixed

[ Top ]

$_showcaption = 1

[line 549]

Tags:

access:

protected

Type:

mixed

[ Top ]

$_showclose = 1

[line 515]

Tags:

access:

protected

Type:

mixed

[ Top ]

$_showicon = 1

[line 531]

Tags:

access:

protected

Type:

mixed

[ Top ]

$_showmaximize = 1

[line 494]

Tags:

access:

protected

Type:

mixed

[ Top ]

$_showminimize = 1

[line 478]

Tags:

access:

protected

Type:

mixed

[ Top ]

$_showstatusbar = 0

[line 608]

Tags:

access:

protected

Type:

mixed

[ Top ]

Class Methods

constructor __construct [line 401]

Window __construct(
[
$aowner = null])

Overrides QWidget::__construct() (parent method not documented)

Parameters:

$aowner

[ Top ]

method commonScript [line 791]

void commonScript(
)

This is an internal method you don't need to call directly

It dumps the common javascript code to update the control if used inside an Ajax call

Tags:

see:

Window::dumpForAjax()

[ Top ]

method defaultIconSource [line 638]

void defaultIconSource(
)

[ Top ]

method defaultIsVisible [line 440]

void defaultIsVisible(
)

[ Top ]

method defaultModal [line 425]

void defaultModal(
)

[ Top ]

method defaultMoveable [line 476]

void defaultMoveable(
)

[ Top ]

method defaultMoveMethod [line 584]

void defaultMoveMethod(
)

[ Top ]

method defaultResizeable [line 459]

void defaultResizeable(
)

[ Top ]

method defaultResizeMethod [line 606]

void defaultResizeMethod(
)

[ Top ]

method defaultShowCaption [line 565]

void defaultShowCaption(
)

[ Top ]

method defaultShowClose [line 529]

void defaultShowClose(
)

[ Top ]

method defaultShowIcon [line 547]

void defaultShowIcon(
)

[ Top ]

method defaultShowMaximize [line 513]

void defaultShowMaximize(
)

[ Top ]

method defaultShowMinimize [line 492]

void defaultShowMinimize(
)

[ Top ]

method defaultShowStatusBar [line 620]

void defaultShowStatusBar(
)

[ Top ]

method dumpContents [line 824]

void dumpContents(
)

Overrides Control::dumpContents() (Dumps the control contents.)

[ Top ]

method dumpForAjax [line 819]

void dumpForAjax(
)

This is an internal method you don't need to call directly

This method is called by the Ajax engine to get the code to update the component after an ajax call

Tags:

see:

Window::commonScript()

[ Top ]

method dumpJavascript [line 748]

void dumpJavascript(
)

Overrides Control::dumpJavascript() (Dumps all required javascript code for the component.)

[ Top ]

method dumpJsEvents [line 734]

void dumpJsEvents(
)

Overrides Control::dumpJsEvents() (Dumps all assigned javascript events code.)

[ Top ]

method getCaption [line 442]

void getCaption(
)

[ Top ]

method getIconSource [line 636]

string getIconSource(
)

Specifies the path to the icon used by the window

Use this property to specify the image to be shown at the top left corner of the window, if none assigned, a default will be used.

To specify if the icon is shown or not, check ShowIcon property

Tags:

see:

Window::getShowIcon()

[ Top ]

method getIsVisible [line 438]

boolean getIsVisible(
)

Specifies if the window is visible or not.

Modal windows are not visible and should be shown using code on a javascript event

Tags:

see:

Window::getModal()

[ Top ]

method getjsOnClick [line 640]

void getjsOnClick(
)

[ Top ]

method getjsOnClose [line 703]

mixed getjsOnClose(
)

Fires when the window is closed

Use this event to get notified when the Window component is closed inside the browser. Here you can write javascript code to react to that event.

[ Top ]

method getjsOnMaximize [line 688]

mixed getjsOnMaximize(
)

Fires when the window is maximized

Use this event to get notified when the Window component is maximized inside the browser. Here you can write javascript code to react to that event.

Tags:

see:

Window::getjsOnMinimize(), Window::getjsOnRestore()

[ Top ]

method getjsOnMinimize [line 656]

mixed getjsOnMinimize(
)

Fires when the window is minimized

Use this event to get notified when the Window component is minimized inside the browser. Here you can write javascript code to react to that event.

Tags:

see:

Window::getjsOnRestore(), Window::getjsOnMaximize()

[ Top ]

method getjsOnMove [line 717]

mixed getjsOnMove(
)

Fires when the window is moved

Use this event to get notified when the Window component is moved inside the browser. Here you can write javascript code to react to that event.

[ Top ]

method getjsOnResize [line 731]

mixed getjsOnResize(
)

Fires when the window is resized

Use this event to get notified when the Window component is resized inside the browser. Here you can write javascript code to react to that event.

[ Top ]

method getjsOnRestore [line 672]

mixed getjsOnRestore(
)

Fires when the window is restored

Use this event to get notified when the Window component is restored from minimized state. Here you can write javascript code to react to that event.

Tags:

see:

Window::getjsOnMinimize(), Window::getjsOnMaximize()

[ Top ]

method getModal [line 423]

boolean getModal(
)

Specifies if the window is modal or not.

A modal window is the one that forces the user to make an action (close the window, click a button, etc) before it can continue with the program.

Use this kind of windows for notifications to the user, or to request some action

Tags:

see:

Window::getIsVisible()

[ Top ]

method getMoveable [line 474]

boolean getMoveable(
)

Specifies if the window allows to be moved.

This property determines if the window component must allow the user to move the window, if false, the window will state at the location it was designed.

Tags:

see:

Window::getResizeable()

[ Top ]

method getMoveMethod [line 582]

enum getMoveMethod(
)

Specifies the method used to move the window, these are the available values:

mmFrame - The windows shows a rectangular frame with the new position

mmOpaque - The window moves at the same time the user moves the mouse

mmTranslucent - The window becomes translucent when moving

Default value is mmOpaque

[ Top ]

method getResizeable [line 457]

boolean getResizeable(
)

Specifies if the window allows to be resized.

This property determines if the window component must allow the user to resize the window in the browser.

Tags:

see:

Window::getMoveable()

[ Top ]

method getResizeMethod [line 604]

enum getResizeMethod(
)

Specifies the method used to resize the window

rmFrame - A frame is shown with the new size

rmOpaque - The window size is changed with the mouse movement

rmLazyOpaque - The size is changed with the mouse movement, but is less updated

rmTranslucent - The size is changed with the mouse movement and the window becomes translucent

Default value is rmFrame

[ Top ]

method getShowCaption [line 563]

boolean getShowCaption(
)

Specifies if the window shows a caption on the title bar

Use this property to specify if the top caption is shown or not, if false, no caption will be shown.

To specify the caption to show, check Caption property

Tags:

see:

Window::getShowIcon(), Window::getCaption()

[ Top ]

method getShowClose [line 527]

boolean getShowClose(
)

Specifies if the window shows the close button or not

Use this property to specify if the close button is shown or not, if false, the user won't be able to close the window.

Tags:

see:

Window::getShowMaximize(), Window::getShowMinimize()

[ Top ]

method getShowIcon [line 545]

boolean getShowIcon(
)

Specifies if the window shows the top left icon or not on the title bar

Use this property to specify if the top left icon is shown or not, if false, no icon will be shown.

To specify which icon is shown, check IconSource property

Tags:

see:

Window::getShowCaption(), Window::getIconSource()

[ Top ]

method getShowMaximize [line 511]

boolean getShowMaximize(
)

Specifies if the window shows the maximize button or not

Use this property to specify if the maximize button is shown or not, if false, the user won't be able to maximize the window.

Tags:

see:

Window::getShowMinimize(), Window::getShowClose()

[ Top ]

method getShowMinimize [line 490]

boolean getShowMinimize(
)

Specifies if the window shows the minimize button or not.

Use this property to specify if the minimize button is shown or not, if false, the user won't be able to minimize the window.

Tags:

see:

Window::getShowMaximize(), Window::getShowClose()

[ Top ]

method getShowStatusBar [line 618]

boolean getShowStatusBar(
)

Specifies if the window shows a status bar or not at the bottom

Use this property to specify if the bottom statusbar is shown or not, if false, no status bar will be shown.

[ Top ]

method getVisible [line 496]

void getVisible(
)

[ Top ]

method setCaption [line 443]

void setCaption(

$value)

Parameters:

$value

[ Top ]

method setIconSource [line 637]

void setIconSource(

$value)

Parameters:

$value

[ Top ]

method setIsVisible [line 439]

void setIsVisible(

$value)

Parameters:

$value

[ Top ]

method setjsOnClick [line 641]

void setjsOnClick(

$value)

Parameters:

$value

[ Top ]

method setjsOnClose [line 704]

void setjsOnClose(

$value)

Parameters:

$value

[ Top ]

method setjsOnMaximize [line 689]

void setjsOnMaximize(

$value)

Parameters:

$value

[ Top ]

method setjsOnMinimize [line 657]

void setjsOnMinimize(

$value)

Parameters:

$value

[ Top ]

method setjsOnMove [line 718]

void setjsOnMove(

$value)

Parameters:

$value

[ Top ]

method setjsOnResize [line 732]

void setjsOnResize(

$value)

Parameters:

$value

[ Top ]

method setjsOnRestore [line 673]

void setjsOnRestore(

$value)

Parameters:

$value

[ Top ]

method setModal [line 424]

void setModal(

$value)

Parameters:

$value

[ Top ]

method setMoveable [line 475]

void setMoveable(

$value)

Parameters:

$value

[ Top ]

method setMoveMethod [line 583]

void setMoveMethod(

$value)

Parameters:

$value

[ Top ]

method setResizeable [line 458]

void setResizeable(

$value)

Parameters:

$value

[ Top ]

method setResizeMethod [line 605]

void setResizeMethod(

$value)

Parameters:

$value

[ Top ]

method setShowCaption [line 564]

void setShowCaption(

$value)

Parameters:

$value

[ Top ]

method setShowClose [line 528]

void setShowClose(

$value)

Parameters:

$value

[ Top ]

method setShowIcon [line 546]

void setShowIcon(

$value)

Parameters:

$value

[ Top ]

method setShowMaximize [line 512]

void setShowMaximize(

$value)

Parameters:

$value

[ Top ]

method setShowMinimize [line 491]

void setShowMinimize(

$value)

Parameters:

$value

[ Top ]

method setShowStatusBar [line 619]

void setShowStatusBar(

$value)

Parameters:

$value

[ Top ]

method setVisible [line 497]

void setVisible(

$value)

Parameters:

$value

[ Top ]

Documentation generated on Sat, 13 Jun 2009 10:51:42 -0700 by phpDocumentor 1.4.1