OOUI\ActionFieldLayout Class Reference
Layout made of a field, button and optional label. More...
Inheritance diagram for OOUI\ActionFieldLayout:
Collaboration diagram for OOUI\ActionFieldLayout:
Public Member Functions | |
| __construct ( $fieldWidget, $buttonWidget=false, array $config=[]) | |
| getConfig (&$config) | |
| @inheritDoc | |
| Public Member Functions inherited from OOUI\FieldLayout | |
| __construct ( $fieldWidget, array $config=[]) | |
| getField () | |
| Get the field. More... | |
| isFieldInline () | |
Return true if the given field widget can be used with ‘'inline’alignment (see setAlignment()). More... | |
| Public Member Functions inherited from OOUI\Layout | |
| __construct (array $config=[]) | |
| 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 | |
| Widget | $buttonWidget |
| Button widget to be laid out. | |
| Tag | $button |
| Tag | $input |
| Protected Attributes inherited from OOUI\FieldLayout | |
| string | $align |
| Alignment. | |
| Widget | $fieldWidget |
| Field widget to be laid out. | |
| array | $errors |
| Error messages. | |
| array | $warnings |
| Warning messages. | |
| array | $successMessages |
| Success messages. | |
| array | $notices |
| Notice messages. | |
| ButtonWidget string | $help |
| Tag | $field |
| Tag | $header |
| Tag | $body |
| Tag | $messages |
| string | $helpText |
| string false | $helpInline |
| 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\FieldLayout | |
| setAlignment ( $value) | |
| Set the field alignment mode. More... | |
| formatTitleWithAccessKey ( $title) | |
| Include information about the widget's accessKey in our title. More... | |
| Protected Member Functions inherited from OOUI\Element | |
| getJavaScriptClassName () | |
| The class name of the JavaScript version of this widget. More... | |
| getGeneratedAttributes () | |
Detailed Description
Layout made of a field, button and optional label.
Constructor & Destructor Documentation
◆ __construct()
| OOUI\ActionFieldLayout::__construct | ( | $fieldWidget, | |
$buttonWidget = false, |
|||
| array | $config = [] |
||
| ) |
- Parameters
-
Widget $fieldWidget Field widget ButtonWidget | ButtonInputWidget $buttonWidget Field widget array $config Configuration options @suppress PhanTypeMismatchDefault Overloaded method
The documentation for this class was generated from the following file:
- php/layouts/ActionFieldLayout.php
