Code Index

Namespaces

Classes


Class CKFinder.ui.dialog.button


Extends CKFinder.ui.dialog.uiElement.

Class Summary
Constructor Attributes Constructor Name and Description
 
CKFinder.ui.dialog.button(dialog, elementDefinition, htmlList)
A button with a label inside.
Method Summary
Method Attributes Method Name and Description
 
Handler for the element's access key down event.
 
Handler for the element's access key up event.
 
Simulates a click to the button.
 
Disables the button.
 
Enables the button.
 
Determines whether this element is enabled or not.
 
Checks if this element is visible.
Methods borrowed from class CKFinder.ui.dialog.uiElement:
focus, getDialog, getElement, getInputElement, getValue, isChanged, selectParentTab, setValue
Class Detail
CKFinder.ui.dialog.button(dialog, elementDefinition, htmlList)
Since: 2.0
A button with a label inside.
Note: the whole CKFinder.ui.dialog namespace is not directly accessible (CKFinder.ui.dialog is undefined).
Instances of this class are created by CKFinder when dialog is created.
To add a button to a dialog, check CKFinder.dialog.definition.button.
Parameters:
{CKFinder.dialog} dialog
Parent dialog object.
{CKFinder.dialog.uiElementDefinition} elementDefinition
The element definition. Accepted fields:
  • label (Required) The button label.
  • disabled (Optional) Set to true if you want the button to appear in disabled state.
{Array} htmlList
List of HTML code to output to.
Method Detail
{Undefined} accessKeyDown()
Since: 2.0
Handler for the element's access key down event. Simulates a mouse down to the button.

{Undefined} accessKeyUp()
Since: 2.0
Handler for the element's access key up event. Simulates a click to the button.

{Object} click()
Since: 2.0
Simulates a click to the button.
Returns:
{Object} Return value of the 'click' event.

{Undefined} disable()
Since: 2.0
Disables the button.

{Undefined} enable()
Since: 2.0
Enables the button.

{Boolean} isEnabled()
Since: 2.0
Determines whether this element is enabled or not.
Returns:
{Boolean} Whether the UI element is enabled.

{Boolean} isVisible()
Since: 2.0
Checks if this element is visible.
Returns:
{Boolean} True if the element is visible.

Copyright © 2007-2015, CKSource - Frederico Knabben. All rights reserved.