OOjsUI
Object-Oriented JavaScript – User Interface
|
Layout made of a field and optional label. More...
Public Member Functions | |
__construct ($fieldWidget, array $config=array()) | |
getField () | |
Get the field. More... | |
getConfig (&$config) | |
![]() | |
__construct (array $config=array()) | |
![]() | |
__construct (array $config=array()) | |
__call ($method, $arguments) | |
Call a mixed-in method. More... | |
__get ($name) | |
Get a mixed-in target property. More... | |
__isset ($name) | |
Check for existence of a mixed-in target property. More... | |
getTagName () | |
Get the HTML tag name. More... | |
getData () | |
Get element data. More... | |
setData ($data) | |
Set element data. More... | |
supports ($methods) | |
Check if element supports one or more methods. More... | |
mixin (ElementMixin $mixin) | |
Mixin a class. More... | |
getConfig (&$config) | |
Add the necessary properties to the given $config array to allow reconstruction of this widget via its constructor. More... | |
toString () | |
Render element into HTML. More... | |
![]() | |
__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... | |
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... | |
appendContent () | |
Add content to the end. More... | |
prependContent () | |
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 () | |
Render element into HTML. More... | |
__toString () | |
Magic method implementation. More... | |
Public Attributes | |
$body | |
$messages | |
Protected Member Functions | |
setAlignment ($value) | |
Set the field alignment mode. More... | |
![]() | |
getJavaScriptClassName () | |
The class name of the JavaScript version of this widget. More... | |
getGeneratedAttributes () | |
![]() | |
getGeneratedAttributes () | |
Return an augmented attributes array, including synthetic attributes which are created from other properties (like the classes array) but which shouldn't be retained in the user-visible attributes . More... | |
Protected Attributes | |
string | $align |
Alignment. | |
Widget | $fieldWidget |
Field widget to be laid out. | |
array | $errors |
Error messages. | |
array | $notices |
Notice messages. | |
ButtonWidget string | $help |
$field | |
![]() | |
mixed | $data = null |
Element data. | |
array | $ownClasses = array() |
Strings of the CSS classes explicitly configured for this element (as opposed to $classes, which contains all classes for this element). | |
array | $mixins = array() |
ElementMixins. More... | |
![]() | |
string | $tag = '' |
Tag name for this instance. More... | |
array | $attributes = array() |
Attributes. More... | |
array | $classes = array() |
Classes. More... | |
array | $content = array() |
Content. More... | |
GroupElement null | $elementGroup = null |
Group. More... | |
boolean | $infusable = false |
Infusion support. More... | |
Additional Inherited Members | |
![]() | |
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 string | $tagName = 'div' |
HTML tag name. More... | |
static string | $defaultDir = 'ltr' |
Default text direction, used for some layout calculations. More... | |
Layout made of a field and optional label.
Available label alignment modes include:
OOUI\FieldLayout::__construct | ( | $fieldWidget, | |
array | $config = array() |
||
) |
Widget | $fieldWidget | Field widget |
array | $config | Configuration options |
string | $config,['align'] | Alignment mode, either 'left', 'right', 'top' or 'inline' (default: 'left') |
array | $config,['errors'] | Error messages about the widget, as strings or HtmlSnippet instances. |
array | $config,['notices'] | Notices about the widget, as strings or HtmlSnippet instances. |
string | HtmlSnippet | $config,['help'] | Explanatory text shown as a '?' icon. |
Exception | An exception is thrown if no widget is specified |
OOUI\FieldLayout::getField | ( | ) |
Get the field.
|
protected |
Set the field alignment mode.
string | $value | Alignment mode, either 'left', 'right', 'top' or 'inline' |