WPDK  1.5.0
WordPress Development Kit
 All Data Structures Files Functions Variables Pages
WPDKUIPopover Class Reference
Inheritance diagram for WPDKUIPopover:
WPDKHTMLTag WPDKObject

Public Member Functions

 __construct ($id, $title= '', $content= '', $placement=WPDKUIPopoverPlacement::RIGHT)
 
 html ()
 Popover. More...
 
 title ()
 Title. More...
 
 content ()
 Content. More...
 
- Public Member Functions inherited from WPDKHTMLTag
 __construct ($tag_name)
 
 addData ($name, $value)
 Add data attribute. More...
 
 addClass ($class)
 Add CSS Class. More...
 
 display ()
 Display. More...
 
 html ()
 Return the HTML markup for this tag. More...
 
 draw ()
 Draw. More...
 
 setPropertiesByArray ($properties=array())
 Set properties by array. More...
 
- Public Member Functions inherited from WPDKObject
 __className ()
 Returns the class object. More...
 
 __parentClass ()
 Returns the class object for the receiver’s superclass. More...
 
 __isClass ($class)
 Brief. More...
 
 __isSubclassOfClass ($class)
 Return TRUE if the receiving class is a subclass of —or identical to— $class, otherwise FALSE. More...
 

Data Fields

 $animation = true
 Animation. More...
 
 $container = false
 COntainer. More...
 
 $content = ''
 Content. More...
 
 $delay = 0
 Deleay. More...
 
 $html = false
 HTML content. More...
 
 $id = ''
 ID. More...
 
 $placement = WPDKUIPopoverPlacement::RIGHT
 
 $selector = ''
 Selector. More...
 
 $static = false
 Static. More...
 
 $title = ''
 Title. More...
 
 $trigger = 'click'
 Trigger. More...
 
- Data Fields inherited from WPDKHTMLTag
 $__version = '1.1.1'
 Version. More...
 
 $accesskey = ''
 
 $class = array()
 
 $content = ''
 Content. More...
 
 $contenteditable
 
 $contextmenu
 
 $data = array()
 Data attribute. More...
 
 $dir
 
 $draggable
 
 $dropzone
 
 $hidden
 
 $id
 
 $lang
 
 $onclick
 
 $spellcheck
 
 $style
 
 $tabindex
 
 $tagName
 Tag name. More...
 
 $title
 
- Data Fields inherited from WPDKObject
 $__version = '1.0.0'
 The version number assigned to the class. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from WPDKHTMLTag
static sanitizeAttributes ($attributes)
 Sanitize attributes. More...
 
static sanitizeData ($attributes)
 Sanitize data attributes. More...
 
static sanitizeClasses ($classes)
 Sanitize CSS Classes list. More...
 
static sanitizeStyles ($styles)
 Sanitize CSS Classes list. More...
 
static attributeInline ($attributes, $additional_attributes=false)
 Inline Data attribute. More...
 
static dataInline ($data, $additional_data=false)
 Inline Data attribute. More...
 
static classInline ($classes, $additional_classes=false)
 Inline CSS class. More...
 
static styleInline ($styles, $additional_styles=false)
 Inline CSS class. More...
 
static mergeClasses ($class, $class2=null, $_=null)
 Merge. More...
 
- Protected Member Functions inherited from WPDKHTMLTag
 beforeContent ()
 Before content. More...
 
 afterContent ()
 After content. More...
 
- Protected Attributes inherited from WPDKHTMLTag
 $attributes = array()
 Attributes list. More...
 
 $close
 Close tag. More...
 
 $open
 Open tag. More...
 

Detailed Description

Author
=undo= info@.nosp@m.wpxt.nosp@m.re.me
Date
2014-02-23
Version
1.0.0
Since
1.5.0

Definition at line 23 of file wpdk-ui-popover.php.

Constructor & Destructor Documentation

__construct (   $id,
  $title = '',
  $content = '',
  $placement = WPDKUIPopoverPlacement::RIGHT 
)

Create an instance of WPDKUIPopover class

Parameters
string$idID attribute
string$titleOptional. Title of popover
string$contentOptional. Content of popover
string$placementOptional. Default WPDKUIPopoverPlacement::RIGHT
Returns
WPDKUIPopover

Definition at line 144 of file wpdk-ui-popover.php.

Member Function Documentation

content ( )

Content.

Return the content of popover

Returns
string

Definition at line 202 of file wpdk-ui-popover.php.

html ( )

Popover.

Return the HTML markup of Popover

Returns
string

Definition at line 159 of file wpdk-ui-popover.php.

title ( )

Title.

Title of popober

Returns
string

Definition at line 189 of file wpdk-ui-popover.php.

Field Documentation

bool $animation = true

Animation.

Apply a CSS fade transition to the popover

Definition at line 32 of file wpdk-ui-popover.php.

bool $container = false

COntainer.

Appends the popover to a specific element. Example: container: 'body'. This option is particularly useful in that it allows you to position the popover in the flow of the document near the triggering element - which will prevent the popover from floating away from the triggering element during a window resize.

Definition at line 44 of file wpdk-ui-popover.php.

string $content = ''

Content.

Content

Definition at line 53 of file wpdk-ui-popover.php.

int string $delay = 0

Deleay.

Delay showing and hiding the popover (ms) - does not apply to manual trigger type If a number is supplied, delay is applied to both hide/show Object structure is: delay: { show: 500, hide: 100 }

Definition at line 63 of file wpdk-ui-popover.php.

bool $html = false

HTML content.

Insert HTML into the popover. If false, jQuery's text method will be used to insert content into the DOM. Use text if you're worried about XSS attacks.

Definition at line 73 of file wpdk-ui-popover.php.

string $id = ''

ID.

ID attribute of main content

Definition at line 82 of file wpdk-ui-popover.php.

Definition at line 94 of file wpdk-ui-popover.php.

string $selector = ''

Selector.

if a selector is provided, popover objects will be delegated to the specified targets. In practice, this is used to enable dynamic HTML content to have popovers added. See http://jsfiddle.net/fScua/

Definition at line 105 of file wpdk-ui-popover.php.

bool $static = false

Static.

Render as static. Default is FALSE

Definition at line 114 of file wpdk-ui-popover.php.

string $title = ''

Title.

Title

Definition at line 123 of file wpdk-ui-popover.php.

string $trigger = 'click'

Trigger.

How popover is triggered - click | hover | focus | manual

Definition at line 132 of file wpdk-ui-popover.php.


The documentation for this class was generated from the following file: