Overview

Packages

  • bootstrap
    • behaviors
    • components
    • form
    • gii
    • helpers
    • widgets

Classes

  • TbActiveForm
  • TbAffix
  • TbAlert
  • TbBreadcrumb
  • TbButtonColumn
  • TbCollapse
  • TbDataColumn
  • TbDetailView
  • TbGridView
  • TbHeroUnit
  • TbListView
  • TbModal
  • TbNav
  • TbNavbar
  • TbPager
  • TbScrollspy
  • TbTabs
  • TbThumbnails
  • TbTypeAhead
  • Overview
  • Package
  • Class
  • Tree

Class TbModal

Bootstrap modal widget.

CWidget
Extended by TbModal
Package: bootstrap\widgets
Copyright: Copyright © Christoffer Niska 2013-
License: New BSD License
Author: Antonio Ramirez <ramirez.cobos@gmail.com>
Located at widgets/TbModal.php
Methods summary
public
# init( )

Widget's initialization method

Widget's initialization method

public
# initEvents( )

Initialize events if any

Initialize events if any

public
# initOptions( )

Initialize plugin options. Important: The display of the button overrides the initialization of the modal bootstrap widget.

Initialize plugin options. Important: The display of the button overrides the initialization of the modal bootstrap widget.

public
# run( )

Widget's run method

Widget's run method

public
# renderButton( )

Renders the button

Renders the button

public
# renderModal( )

Renders the modal markup

Renders the modal markup

public
# renderModalHeader( )

Renders the header HTML markup of the modal

Renders the header HTML markup of the modal

public
# renderModalBody( )

Renders the HTML markup for the body of the modal

Renders the HTML markup for the body of the modal

public
# renderModalFooter( )

Renders the HTML markup for the footer of the modal

Renders the HTML markup for the footer of the modal

public
# registerClientScript( )

Registers necessary client scripts.

Registers necessary client scripts.

Properties summary
public array $htmlOptions array()
#

the HTML options for the view container tag.

the HTML options for the view container tag.

public array $buttonOptions array()
#
The additional HTML attributes of the button that will show the modal. If empty array, only the markup of the modal will be rendered on the page, so users can easily call the modal manually with their own scripts. The following special attributes are available:
  • label: string, the label of the button

For available options of the button trigger, see http://twitter.github.com/bootstrap/javascript.html#modals.

The additional HTML attributes of the button that will show the modal. If empty array, only the markup of the modal will be rendered on the page, so users can easily call the modal manually with their own scripts. The following special attributes are available:
  • label: string, the label of the button

For available options of the button trigger, see http://twitter.github.com/bootstrap/javascript.html#modals.

public boolean $fade true
#

indicates whether the modal should use transitions. Defaults to 'true'.

indicates whether the modal should use transitions. Defaults to 'true'.

public boolean $keyboard true
#

$keyboard, closes the modal when escape key is pressed.

$keyboard, closes the modal when escape key is pressed.

public boolean $show false
#

$show, shows the modal when initialized.

$show, shows the modal when initialized.

public mixed $backdrop true
#

includes a modal-backdrop element. Alternatively, specify static for a backdrop which doesn't close the modal on click.

includes a modal-backdrop element. Alternatively, specify static for a backdrop which doesn't close the modal on click.

public mixed $remote
#

the remote url. If a remote url is provided, content will be loaded via jQuery's load method and injected into the .modal-body of the modal.

the remote url. If a remote url is provided, content will be loaded via jQuery's load method and injected into the .modal-body of the modal.

public string $onShow
#

a javascript function that will be invoked immediately when the show instance method is called.

a javascript function that will be invoked immediately when the show instance method is called.

public string $onShown
#

a javascript function that will be invoked when the modal has been made visible to the user
(will wait for css transitions to complete).

a javascript function that will be invoked when the modal has been made visible to the user (will wait for css transitions to complete).

public string $onHide
#

a javascript function that will be invoked immediately when the hide instance method has been called.

a javascript function that will be invoked immediately when the hide instance method has been called.

public string $onHidden
#

a javascript function that will be invoked when the modal has finished being hidden from the user
(will wait for css transitions to complete).

a javascript function that will be invoked when the modal has finished being hidden from the user (will wait for css transitions to complete).

protected string[] $events array()
#

the Javascript event handlers.

the Javascript event handlers.

protected array $options array()
#

$options the plugin options.

$options the plugin options.

public string $closeText TbHtml::CLOSE_TEXT
#
public string $header
#

header content

header content

public string $content
#

body of modal

body of modal

public string $footer
#

footer content

footer content

Yiistrap API documentation generated by ApiGen 2.8.0