0 results found

tinymce.ui.ColorSplitButton

Contribute to this page
Namespacetinymce.ui
ClassColorSplitButton
InheritanceColorSplitButton SplitButton Button Control

This class is used to create UI color split button. A color split button will present show a small color picker when you press the open menu.

Public Properties

PropertyDefined By
settings : Object : Settings object.ColorSplitButton
value : String : Current color value.ColorSplitButton

Public Methods

MethodDefined By
ColorSplitButton(id:String, s:Object, ed:Editor) : Constructs a new color split button control instance.ColorSplitButton
destroy():void : Destroys the control.ColorSplitButton
displayColor(c:String):void : Change the currently selected color for the control.ColorSplitButton
hideMenu(e:Event):void : Hides the color menu.ColorSplitButton
isActive():Boolean : Returns true/false if the control is disabled or not.Control
isDisabled():Boolean : Returns true/false if the control is disabled or not.Control
isRendered():Boolean : Returns true/false if the control has been rendered or not.Control
postRender():void : Post render event.ColorSplitButton
remove():void : Removes the control.Control
renderHTML():String : Renders the split button as a HTML string.SplitButton
renderMenu():void : Renders the menu to the DOM.ColorSplitButton
renderTo(n:Element):void : Renders the control to the specified container element.Control
setActive(s:Boolean):void : Sets the activated state for the control.Control
setColor(c:String):void : Sets the current color for the control and hides the menu if it should be visible.ColorSplitButton
setDisabled(s:Boolean):void : Sets the disabled state for the control.Control
setState(c:String, s:Boolean):void : Sets the specified class state for the control.Control
showMenu():void : Shows the color menu.ColorSplitButton

Public Events

EventDefined By
onHideMenu() : Fires when the menu is hidden.ColorSplitButton
onShowMenu() : Fires when the menu is shown.ColorSplitButton

Property details

settings

public settings : Object
Settings object.

value

public value : String
Current color value.

Method details

ColorSplitButton

public function ColorSplitButton(id:String, s:Object, ed:Editor)
Constructs a new color split button control instance.

Parameters

ParamDetail
id:StringControl id for the color split button.
s:ObjectOptional name/value settings object.
ed:EditorThe editor instance this button is for.

destroy

public function destroy():void
Destroys the control. This means it will be removed from the DOM and any events tied to it will also be removed.

displayColor

public function displayColor(c:String):void
Change the currently selected color for the control.

Parameters

ParamDetail
c:StringColor code value in hex for example: #FF00FF

hideMenu

public function hideMenu(e:Event):void
Hides the color menu. The optional event parameter is used to check where the event occured so it doesn't close them menu if it was a event inside the menu.

Parameters

ParamDetail
e:EventOptional event object.

postRender

public function postRender():void
Post render event. This will be executed after the control has been rendered and can be used to set states, add events to the control etc. It's recommended for subclasses of the control to call this method by using this.parent().

renderMenu

public function renderMenu():void
Renders the menu to the DOM.

setColor

public function setColor(c:String):void
Sets the current color for the control and hides the menu if it should be visible.

Parameters

ParamDetail
c:StringColor code value in hex for example: #FF00FF

showMenu

public function showMenu():void
Shows the color menu. The color menu is a layer places under the button and displays a table of colors for the user to pick from.

Event details

onHideMenu

public event onHideMenu()
Fires when the menu is hidden.

onShowMenu

public event onShowMenu()
Fires when the menu is shown.

Except as otherwise noted, the content of this page is licensed under the Creative Commons BY-NC-SA 3.0 License, and code samples are licensed under the Apache 2.0 License.