Name

formatbtn

Synopsis

LZX: formatbtn
JavaScript: formatbtn
Type: Class
Access: public
Topic: Incubator.Rich Text Editor
Declared in: lps/components/incubator/rich-text/formatbtn.lzx

Description

class for use of richtexttoolbar buttons

Superclass Chain

node (LzNode) » view (LzView) » basecomponent » basebutton » stylishbutton » formatbtn

Known Subclasses

Details

Properties (7)

activecolor
<attribute name="activecolor" value="0xEAE4B7" />
public var activecolor;
the tint for when the button is active. when inactive, use "tint" attribute.
activetooltiptext
<attribute name="activetooltiptext" type="string" value="" />
public var activetooltiptext : String;
Text to show in tooltip when this is active
editor
<attribute name="editor" value="$once{this.parent.editor}" />
public var editor;
a reference to toolbar's editor
format
<attribute name="format" type="string" />
public var format : String;
the format type that the button will control
inactivetooltiptext
<attribute name="inactivetooltiptext" type="string" value="" />
public var inactivetooltiptext : String;
Text to show in tooltip when this is inactive
isactive
<attribute name="isactive" value="false" />
public var isactive;
active state boolean
toolbar
<attribute name="toolbar" value="$once{this.parent}" />
public var toolbar;
a reference to the toolbar parent

Methods (4)

getValue()
<method name="getValue" />
public function getValue();
init()
<method name="init" />
public function init();
reset()
<method name="reset" />
public function reset();
method broadcast out by the toolbar for clearing tool's state
setState()
<method name="setState" args="state" />
public function setState(state);
method broadcast out by the toolbar for setting tool's state

LZX Synopsis

<class name="formatbtn" extends=" stylishbutton ">
  <attribute name=" activecolor " value="0xEAE4B7" />
  <attribute name=" activetooltiptext " type="string" value="" />
  <attribute name=" editor " value="$once{this.parent.editor}" />
  <attribute name=" format " type="string" />
  <attribute name=" inactivetooltiptext " type="string" value="" />
  <attribute name=" isactive " value="false" />
  <attribute name=" toolbar " value="$once{this.parent}" />
  <method name=" getValue " />
  <method name=" init " />
  <method name=" reset " />
  <method name=" setState " args="state" />
</class>

JavaScript Synopsis

public formatbtn extends  stylishbutton  {
  public var activecolor ;
  public var activetooltiptext  : String;
  public var editor ;
  public var format  : String;
  public var inactivetooltiptext  : String;
  public var isactive ;
  public var toolbar ;
  prototype public function getValue ();
  prototype public function init ();
  prototype public function reset ();
  prototype public function setState (state);
}