xplo.re Medusa Core Framework 3.1
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Event
  • Todo
  • Download

Namespaces

  • Core
    • Authentication
      • Auto
        • Driver
      • Driver
    • Cache
      • Driver
    • Charset
      • Driver
    • Configuration
    • Controller
    • Converter
      • Driver
    • Decoder
      • Driver
    • Encoder
      • Driver
    • Env
      • Authentication
      • Locale
      • Proxy
      • Server
        • HTTP
        • Redirect
        • X
    • Exception
    • Exchange
      • Driver
    • Field
    • Filter
      • Driver
    • Formatter
      • Driver
        • coreuimarkup
          • Token
    • Hash
    • Loader
    • Locale
    • Log
      • Driver
    • Module
      • Dependency
        • Requirement
          • Core
          • PHP
      • Linkage
        • Driver
    • PDF
    • Plugin
    • Query
      • Driver
    • Server
      • Driver
    • Session
      • Driver
    • Set
    • Storage
      • Driver
      • Field
        • Element
    • Stream
      • Driver
    • String
    • Translation
      • Driver
      • Language
        • Driver
    • URI
      • Driver
    • Version
    • View
      • Driver
        • coreui
          • Control
            • Button
            • Table
          • Element
        • htmlbuilder
          • Tags
        • yui
          • Modules
  • None
  • PHP

Classes

  • Button
  • Dialog
  • Table

Class Dialog

Dialogs present a windows of options to the user, that overlays other contents. It is possible to use multiple dialogs at once. Usually, after work in a dialog is completed, the user can confirm his actions and the dialog is removed from view.

Dialogs can also be shown modal, which prevents the user from interacting with other page contents until he has confirmed or closed the dialog.

A dialog has a title and a content area, a bar for standard buttons and optionally an icon. The actual content can be any structure that can be placed inside a container element. Additionally, a dialog can be made draggable, which allows the user to move the dialog around by grabbing the title bar.

Core\Object implements Core\Chainable
Extended by Core\Set implements Core\Accessor
Extended by Core\View\Driver\coreui\Control implements Core\Configurable
Extended by Core\View\Driver\coreui\Control\Dialog implements Core\View\Driver\coreui\Dynamo
Namespace: Core\View\Driver\coreui\Control
Package: CoreUI\Control
Since: 3.1
Requires: PHP 5.3
Version: 1.0
Located at View/Driver/coreui/Control/Dialog.inc.php

Methods summary

public
# __construct( Core\View\Driver\coreui $proxy, array $options = null )

Parameters

$proxy
CoreUI proxy instance that created this element instance.
$options

Associative key-value array of options to set. Equals a call to the Core\View\Driver\coreui\Control::setOptions() method after constructing a new instance.

Since

3.1

Overrides

Core\View\Driver\coreui\Control::__construct
public string
# __toString( )

Renders the HTML code for the control.

Renders the HTML code for the control.

Returns

string

Remark

Dialogs are created dynamically on request and have no static HTML.

Since

3.1

Overrides

Core\View\Driver\coreui\Control::__toString
public string
# bind( string $method )

Binds a method to the dialog instance.

Binds a method to the dialog instance.

Parameters

$method
Name of dialog instance method to bind.

Returns

string
JavaScript block for operation.

Since

3.1
public string
# hide( )

Hides the dialog instance.

Hides the dialog instance.

Returns

string
JavaScript block for operation.

Since

3.1
public string
# renderJS( )

Renders JavaScript block to be executed after page has loaded.

Renders JavaScript block to be executed after page has loaded.

Returns

string

Block of JavaScript that is automatically executed after the page has loaded and the DOM is accessible.

Since

3.1

Implementation of

Core\View\Driver\coreui\Dynamo::renderJS()
public
# setContent( mixed $content )

Sets the dialog content.

Sets the dialog content.

Parameters

$content
Dialog content. Supports element nodes, controls or raw HTML.

Returns


$this

Since

3.1
public
# setDraggable( boolean $flag )

Sets the draggable flag for the dialog.

Sets the draggable flag for the dialog.

Parameters

$flag
If set to true, the dialog will be draggable by default, otherwise not.

Returns


$this

Since

3.1
public
# setIcon( string $icon )

Sets or removes an assigned icon.

Sets or removes an assigned icon.

Parameters

$icon

Icon name to assign. The icon is resolved via the assigned proxy as a resource of the image class. The icon name should accordingly reflect the resource directory architecture, i.e. "icon:info" for an info icon in the icon-subdirectory of the image resource repository. The file extension is resolved automatically. If null, a previously assigned icon is removed.

Returns


$this

Since

3.1
public string
# show( )

Shows the dialog.

Shows the dialog.

Returns

string
JavaScript block for operation.

Since

3.1
public string
# showModal( )

Shows the dialog as a modal.

Shows the dialog as a modal.

Returns

string
JavaScript block for operation.

Since

3.1

Methods inherited from Core\View\Driver\coreui\Control

_T(), __clone(), derive(), id(), on(), setOption(), setOptions(), setTitle(), setTranslator()

Methods inherited from Core\Set

__get(), __isset()

Methods inherited from Core\Object

__autocreateFactory(), __call(), __processParameters(), attachMethod(), chain(), getValueForKey(), getValueForKeyPath(), getValueForUndefinedKey(), hash(), issetValueForKey(), setValueForKey(), setValueForKeyPath(), setValueForUndefinedKey(), uuid()

Constants summary

Constants inherited from Core\Object

AnyParameterType, AutochainParameterType, AutocreateParameterType, BooleanParameterType, CharParameterType, EnumParameterType, IntegerParameterType, RealParameterType, StringParameterType, UserParameterType

Properties summary

protected ArrayObject $_v_buttons

Array of dialog button controls.

Array of dialog button controls.

Since

3.1
#

Properties inherited from Core\View\Driver\coreui\Control

$_id, $_v_options, $_v_proxy, $_v_translator

Magic properties

public read-only ArrayObject $buttons

Array of dialog button controls.

Magic properties inherited from Core\View\Driver\coreui\Control

$id, $options, $proxy, $translator

Magic properties inherited from Core\Object

$hash, $uuid

xplo.re Medusa Core Framework 3.1 API documentation generated by ApiGen