OOUI\Widget Class Reference
User interface control. More...
Inheritance diagram for OOUI\Widget:
Collaboration diagram for OOUI\Widget:
Public Member Functions | |
| __construct (array $config=[]) | |
| isDisabled () | |
| Check if the widget is disabled. More... | |
| setDisabled ( $disabled) | |
| Set the disabled state of the widget. More... | |
| getInputId () | |
Get an ID of a labelable node which is part of this widget, if any, to be used for <label for> value. More... | |
| setLabelledBy ( $id) | |
| Set the element with the given ID as a label for this widget. More... | |
| getConfig (&$config) | |
| @inheritDoc | |
| Public Member Functions inherited from OOUI\Element | |
| getTagName () | |
| Get the HTML tag name. More... | |
| toggle ( $show=null) | |
| Toggle visibility of an element. More... | |
| getData () | |
| Get element data. More... | |
| setData ( $data) | |
| Set element data. More... | |
| supports ( $methods) | |
| Check if element supports one or more methods. More... | |
| registerConfigCallback (callable $func) | |
| Register an additional function to call when building the config. More... | |
| toString () | |
| Render element into HTML. More... | |
| Public Member Functions inherited from OOUI\Tag | |
| __construct ( $tag='div') | |
| Create element. More... | |
| hasClass ( $class) | |
| Check for CSS class. More... | |
| addClasses (array $classes) | |
| Add CSS classes. More... | |
| removeClasses (array $classes) | |
| Remove CSS classes. More... | |
| toggleClasses (array $classes, $toggle=null) | |
| Toggle CSS classes. More... | |
| getTag () | |
| getAttribute ( $key) | |
| Get HTML attribute value. More... | |
| setAttributes (array $attributes) | |
| Add HTML attributes. More... | |
| setValue ( $value) | |
| Set value of input element ('value' attribute for most, element content for textarea). More... | |
| removeAttributes (array $keys) | |
| Remove HTML attributes. More... | |
| removeContent (... $content) | |
| Remove any items that match by reference. More... | |
| appendContent (... $content) | |
| Add content to the end. More... | |
| prependContent (... $content) | |
| Add content to the beginning. More... | |
| clearContent () | |
| Remove all content. More... | |
| getElementGroup () | |
| Get group element is in. More... | |
| setElementGroup ( $group) | |
| Set group element is in. More... | |
| setInfusable ( $infusable) | |
| Enable widget for client-side infusion. More... | |
| isInfusable () | |
| Get client-side infusability. More... | |
| ensureInfusableId () | |
Ensure that this given Tag is infusable and has a unique id attribute. More... | |
| __toString () | |
| Magic method implementation. More... | |
Protected Attributes | |
| bool | $disabled = false |
| Disabled. More... | |
| 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. More... | |
| array | $attributes = [] |
| Attributes. More... | |
| array | $classes = [] |
| Classes. More... | |
| array | $content = [] |
| Content. More... | |
| GroupElement null | $elementGroup = null |
| Group. More... | |
| bool | $infusable = false |
| Infusion support. More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from OOUI\Element | |
| static | warnDeprecation ( $message='') |
| Emits a deprecation warning with provided message. More... | |
| static | getDir (Tag $element) |
| Get the direction of the user interface for a given element. More... | |
| static | setDefaultDir ( $dir) |
| Set the default direction of the user interface. More... | |
| 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. More... | |
| Static Public Member Functions inherited from OOUI\Tag | |
| static | generateElementId () |
| Generate a unique ID for element. More... | |
| static | isSafeUrl ( $url) |
| Check whether user-supplied URL is safe, that is, whether outputting it will not result in XSS vulnerability. More... | |
| Static Public Attributes inherited from OOUI\Element | |
| static string | $tagName = 'div' |
| HTML tag name. More... | |
| static string | $defaultDir = 'ltr' |
| Default text direction, used for some layout calculations. More... | |
| Protected Member Functions inherited from OOUI\Element | |
| getJavaScriptClassName () | |
| The class name of the JavaScript version of this widget. More... | |
| getGeneratedAttributes () | |
Detailed Description
User interface control.
@abstract
Constructor & Destructor Documentation
◆ __construct()
| OOUI\Widget::__construct | ( | array | $config = [] | ) |
- Parameters
-
array $config Configuration options - bool $config['disabled'] Disable (default: false)
Reimplemented from OOUI\Element.
Reimplemented in OOUI\TextInputWidget, OOUI\TabSelectWidget, OOUI\TabOptionWidget, OOUI\SelectWidget, OOUI\SelectFileInputWidget, OOUI\SearchInputWidget, OOUI\RadioSelectInputWidget, OOUI\RadioInputWidget, OOUI\ProgressBarWidget, OOUI\OptionWidget, OOUI\NumberInputWidget, OOUI\MultilineTextInputWidget, OOUI\MessageWidget, OOUI\LabelWidget, OOUI\InputWidget, OOUI\IndicatorWidget, OOUI\IconWidget, OOUI\DropdownInputWidget, OOUI\ComboBoxInputWidget, OOUI\CheckboxMultiselectInputWidget, OOUI\CheckboxInputWidget, OOUI\ButtonWidget, OOUI\ButtonInputWidget, OOUI\ButtonGroupWidget, and OOUI\HiddenInputWidget.
Member Function Documentation
◆ getInputId()
| OOUI\Widget::getInputId | ( | ) |
Get an ID of a labelable node which is part of this widget, if any, to be used for <label for> value.
- Returns
- string|null The ID of the labelable node
Reimplemented in OOUI\ButtonInputWidget.
◆ isDisabled()
| OOUI\Widget::isDisabled | ( | ) |
Check if the widget is disabled.
- Returns
- bool Button is disabled
◆ setDisabled()
| OOUI\Widget::setDisabled | ( | $disabled | ) |
Set the disabled state of the widget.
This should probably change the widgets' appearance and prevent it from being used.
- Parameters
-
bool $disabled Disable widget
- Returns
- $this
Reimplemented in OOUI\RadioSelectInputWidget, OOUI\InputWidget, and OOUI\CheckboxMultiselectInputWidget.
◆ setLabelledBy()
| OOUI\Widget::setLabelledBy | ( | $id | ) |
Set the element with the given ID as a label for this widget.
- Parameters
-
string | null $id
Member Data Documentation
◆ $disabled
|
protected |
Disabled.
Widget is disabled
The documentation for this class was generated from the following file:
- php/Widget.php
