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 Button

Generic-purpose button control. Usually used to trigger dynamic components such as dialogs.

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\Button

Direct known subclasses

Core\View\Driver\coreui\Control\Button\Navigate, Core\View\Driver\coreui\Control\Button\Submit

Namespace: Core\View\Driver\coreui\Control
Package: CoreUI\Control
Since: 3.1
Requires: PHP 5.3
Version: 1.1
Located at View/Driver/coreui/Control/Button.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

Since

3.1

Overrides

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

Returns an automatically assigned ID for the control. The ID is generated on first request and buffered by the control. An ID is unique per instance and automatically reset if a control is cloned.

Returns an automatically assigned ID for the control. The ID is generated on first request and buffered by the control. An ID is unique per instance and automatically reset if a control is cloned.

Returns

string
ID of control (or central element by the control).

Since

3.1

Overrides

Core\View\Driver\coreui\Control::id
public
# setAccessKey( string $accessKey )

Sets an access key that allows the user to click the button using a key combination of the access key and modifiers that depend on the browser.

Sets an access key that allows the user to click the button using a key combination of the access key and modifiers that depend on the browser.

Parameters

$accessKey
Single character string with access key to assign.

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:alert" for an alert 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
# setImage( string $imageURL )

Sets a fully-resolved icon image. To set an icon via the proxy resource resolver, use the Core\View\Driver\coreui\Control\Button::setIcon() method.

Sets a fully-resolved icon image. To set an icon via the proxy resource resolver, use the Core\View\Driver\coreui\Control\Button::setIcon() method.

Parameters

$imageURL
URL of image resource to assign as an icon.

Returns


$this

Since

3.1
public
# setName( string $name )

Sets the name for the control.

Sets the name for the control.

Parameters

$name
Name to set.

Returns


$this

Since

3.1
public
# setText( string $text )

Sets the button text.

Sets the button text.

Parameters

$text

Button text to set. The text is automatically encoded. If set to null or an empty string, the text is removed.

Returns


$this

Since

3.1
public
# setValue( string $value )

Sets the button value (hidden from the user).

Sets the button value (hidden from the user).

Parameters

$value
Value to set.

Returns


$this

Since

3.1

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

_T(), __clone(), derive(), 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 Core\View\Driver\coreui\Element\BUTTON $_v_control

Button element node.

Button element node.

Since

3.1
#

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

$_id, $_v_options, $_v_proxy, $_v_translator

Magic properties

public read-only Core\View\Driver\coreui\Element $control

Root element node for control.

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