OOUI
Object-Oriented User Interface
|
IndexLayouts contain TabPanelLayout layouts as well as TabSelectWidget tabs that allow users to navigate through the tab panels and select which one to display. More...
Public Member Functions | |
__construct (array $config=[]) | |
getConfig (&$config) | |
@inheritDoc | |
getTabs () | |
Get the tabs widget. | |
getTabPanel ( $name) | |
Get a tab panel by its symbolic name. | |
getCurrentTabPanel () | |
getCurrentTabPanelName () | |
addTabPanels (array $tabPanels) | |
Add tab panels to the index layout. | |
setTabPanel ( $name) | |
Set the current tab panel by symbolic name. | |
Public Member Functions inherited from OOUI\MenuLayout | |
toggleMenu ( $showMenu) | |
setMenuPosition ( $position) | |
setMenuPanel (PanelLayout $menuPanel) | |
setContentPanel (PanelLayout $contentPanel) | |
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. | |
setValue ( $value) | |
Set value of input element ('value' attribute for most, element content for textarea). | |
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 | |
StackLayout | $stackLayout |
PanelLayout | $tabPanel |
TabPanelLayout[] | $tabPanels |
TabSelectWidget | $tabSelectWidget |
bool | $autoFocus |
bool | $continuous |
string | $currentTabPanelName |
Protected Attributes inherited from OOUI\MenuLayout | |
Tag | $menuWrapper |
Tag | $contentWrapper |
PanelLayout | $menuPanel |
PanelLayout | $contentPanel |
string | $menuPosition |
bool | $expanded |
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 () | |
IndexLayouts contain TabPanelLayout layouts as well as TabSelectWidget tabs that allow users to navigate through the tab panels and select which one to display.
Default php rendering shows all the tabs
OOUI\IndexLayout::__construct | ( | array | $config = [] | ) |
array | $config | Configuration options
|
Reimplemented from OOUI\MenuLayout.
OOUI\IndexLayout::addTabPanels | ( | array | $tabPanels | ) |
Add tab panels to the index layout.
When tab panels are added with the same names as existing tab panels, the existing tab panels will be automatically removed before the new tab panels are added.
TabPanelLayout[] | $tabPanels | Tab panels to add |
OOUI\IndexLayout::getConfig | ( | & | $config | ) |
@inheritDoc
Reimplemented from OOUI\MenuLayout.
OOUI\IndexLayout::getCurrentTabPanel | ( | ) |
OOUI\IndexLayout::getCurrentTabPanelName | ( | ) |
OOUI\IndexLayout::getTabPanel | ( | $name | ) |
Get a tab panel by its symbolic name.
string | $name | Symbolic name of table panel |
OOUI\IndexLayout::getTabs | ( | ) |
Get the tabs widget.
OOUI\IndexLayout::setTabPanel | ( | $name | ) |
Set the current tab panel by symbolic name.
string | $name | Symbolic name of tab panel |