OOUI
Object-Oriented User Interface
|
Toggle widget. More...
Public Member Functions | |
__construct (array $config=[]) | |
getConfig (&$config) | |
@inheritDoc | |
getValue () | |
Get value representing toggle state. | |
setValue ( $value=null) | |
Set the value of the widget. | |
Public Member Functions inherited from OOUI\Widget | |
isDisabled () | |
Check if the widget is disabled. | |
setDisabled ( $disabled) | |
Set the disabled state of the widget. | |
getInputId () | |
Get an ID of a labelable node which is part of this widget, if any, to be used for <label for> value. | |
setLabelledBy ( $id) | |
Set the element with the given ID as a label for this widget. | |
Public Member Functions inherited from OOUI\Element | |
getTagName () | |
Get the HTML tag name. | |
toggle ( $show=null) | |
Toggle visibility of an element. | |
getData () | |
Get element data. | |
setData ( $data) | |
Set element data. | |
supports ( $methods) | |
Check if element supports one or more methods. | |
registerConfigCallback (callable $func) | |
Register an additional function to call when building the config. | |
toString () | |
Render element into HTML. | |
Public Member Functions inherited from OOUI\Tag | |
__construct ( $tag='div') | |
Create element. | |
hasClass ( $class) | |
Check for CSS class. | |
addClasses (array $classes) | |
Add CSS classes. | |
removeClasses (array $classes) | |
Remove CSS classes. | |
toggleClasses (array $classes, $toggle=null) | |
Toggle CSS classes. | |
getTag () | |
getAttribute ( $key) | |
Get HTML attribute value. | |
setAttributes (array $attributes) | |
Add HTML attributes. | |
removeAttributes (array $keys) | |
Remove HTML attributes. | |
removeContent (... $content) | |
Remove any items that match by reference. | |
appendContent (... $content) | |
Add content to the end. | |
prependContent (... $content) | |
Add content to the beginning. | |
clearContent () | |
Remove all content. | |
getElementGroup () | |
Get group element is in. | |
setElementGroup ( $group) | |
Set group element is in. | |
setInfusable ( $infusable) | |
Enable widget for client-side infusion. | |
isInfusable () | |
Get client-side infusability. | |
ensureInfusableId () | |
Ensure that this given Tag is infusable and has a unique id attribute. | |
__toString () | |
Magic method implementation. | |
Protected Attributes | |
bool | $value |
Defines the value of the widget. | |
Protected Attributes inherited from OOUI\Widget | |
bool | $disabled = false |
Disabled. | |
Protected Attributes inherited from OOUI\Element | |
mixed | $data = null |
Element data. | |
bool | $visible = true |
array | $ownClasses = [] |
Strings of the CSS classes explicitly configured for this element (as opposed to #$classes, which contains all classes for this element). | |
callable[] | $configCallbacks = [] |
Protected Attributes inherited from OOUI\Tag | |
string | $tag = '' |
Tag name for this instance. | |
array | $attributes = [] |
Attributes. | |
array | $classes = [] |
Classes. | |
array | $content = [] |
Content. | |
GroupElement null | $elementGroup = null |
Group. | |
bool | $infusable = false |
Infusion support. | |
Additional Inherited Members | |
Static Public Member Functions inherited from OOUI\Element | |
static | warnDeprecation ( $message='') |
Emits a deprecation warning with provided message. | |
static | getDir (Tag $element) |
Get the direction of the user interface for a given element. | |
static | setDefaultDir ( $dir) |
Set the default direction of the user interface. | |
static | configFromHtmlAttributes (array $attrs) |
A helper method to massage an array of HTML attributes into a format that is more likely to work with an OOUI PHP element, camel-casing attribute names and setting values of boolean ones to true. | |
Static Public Member Functions inherited from OOUI\Tag | |
static | generateElementId () |
Generate a unique ID for element. | |
static | resetElementId () |
Reset the unique ID, for consistent test output. | |
static | isSafeUrl ( $url) |
Check whether user-supplied URL is safe, that is, whether outputting it will not result in XSS vulnerability. | |
Static Public Attributes inherited from OOUI\Element | |
static string | $tagName = 'div' |
HTML tag name. | |
static string | $defaultDir = 'ltr' |
Default text direction, used for some layout calculations. | |
Protected Member Functions inherited from OOUI\Element | |
getJavaScriptClassName () | |
The class name of the JavaScript version of this widget. | |
getGeneratedAttributes () | |
Toggle widget.
OOUI\ToggleWidget::__construct | ( | array | $config = [] | ) |
array | $config | Configuration options
|
Reimplemented from OOUI\Widget.
Reimplemented in OOUI\ToggleSwitchWidget.
OOUI\ToggleWidget::getConfig | ( | & | $config | ) |
OOUI\ToggleWidget::getValue | ( | ) |
Get value representing toggle state.
OOUI\ToggleWidget::setValue | ( | $value = null | ) |
Set the value of the widget.
bool | null | $value | Widget |
Reimplemented from OOUI\Tag.
Reimplemented in OOUI\ToggleSwitchWidget.