goog.ui.editor.ToolbarFactory

Provided By	`goog.ui.editor.ToolbarFactory`

Adds a menu item to the given font menu button. The first font listed in the value argument is considered the font ID, so adding two items whose CSS style starts with the same font may lead to unpredictable results.

Parameters

`button`	`goog.ui.Select`
	Font menu button.
`caption`	`string`
	Caption to show for the font menu.
`value`	`string`
	Value for the corresponding 'font-family' CSS style.

VIEW SOURCE

Adds a menu item to the given font size menu button. The value argument must be a legacy HTML font size in the 0-7 range.

Parameters

`button`	`goog.ui.Select`
	Font size menu button.
`caption`	`string`
	Caption to show in the font size menu.
`value`	`number`
	Value for the corresponding HTML font size.

VIEW SOURCE

Bulk-adds font sizes to the given font size menu button. The argument must be an array of font size descriptor objects, each of which must have the following attributes:

`caption` - Caption to show in the font size menu (e.g. 'Huge')
`value` - Value for the corresponding HTML font size (e.g. 6)

Parameters

`button`	`goog.ui.Select`
	Font size menu button.
`sizes`	`Array<{caption: string, value: number}>`
	Array of font size descriptors.

VIEW SOURCE

Bulk-adds fonts to the given font menu button. The argument must be an array of font descriptor objects, each of which must have the following attributes:

`caption` - Caption to show in the font menu (e.g. 'Tahoma')
`value` - Value for the corresponding 'font-family' CSS style (e.g. 'Tahoma, Arial, sans-serif')

Parameters

`button`	`goog.ui.Select`
	Font menu button.
`fonts`	`Array<{caption: string, value: string}>`
	Array of font descriptors.

VIEW SOURCE

Adds a menu item to the given "Format block" menu button.

Parameters

`button`	`goog.ui.Select`
	"Format block" menu button.
`caption`	`string`
	Caption to show in the menu.
`tag`	`goog.dom.TagName`
	Corresponding block format tag.

VIEW SOURCE

Bulk-adds format options to the given "Format block" menu button. The argument must be an array of format option descriptor objects, each of which must have the following attributes:

`caption` - Caption to show in the menu (e.g. 'Minor heading')
`command` - Corresponding goog.dom.TagName (e.g. 'H4')

Parameters

`button`	`goog.ui.Select`
	"Format block" menu button.
`formats`	`Array<{caption: string, command: goog.dom.TagName}>`
	Array of format option descriptors.

VIEW SOURCE

Converts a pixel font size specification into an equivalent legacy size. For example, font-size: 32px; is <font size="6">, etc. If the given pixel size doesn't exactly match one of the legacy sizes, -1 is returned.

Parameters

`px`	`number`
	Pixel font size.

Returns

number

Equivalent legacy size spec in the 0-7 range, or -1 if none exists.

VIEW SOURCE

Takes a font spec (e.g. "Arial, Helvetica, sans-serif") and returns the primary font name, normalized to lowercase (e.g. "arial").

Parameters

`fontSpec`	`string`
	Font specification.

Returns

string

The primary font name, in lowercase.

VIEW SOURCE

Converts a legacy font size specification into an equivalent pixel size. For example, <font size="6"> is font-size: 32px;, etc.

Parameters

`fontSize`	`number`
	Legacy font size spec in the 0-7 range.

Returns

number

Equivalent pixel size.

VIEW SOURCE

Creates a toolbar button with the given ID, tooltip, and caption. Applies any custom CSS class names to the button's caption element.

Parameters

`id`	`string`
	Button ID; must equal a `goog.editor.Command` for built-in buttons, anything else for custom buttons.
`tooltip`	`string`
	Tooltip to be shown on hover.
`caption`	`(string\|Node\|Array<Node>\|NodeList<Node>\|null)`
	Button caption.
`opt_classNames`	`string=`
	CSS class name(s) to apply to the caption element.
`opt_renderer`	`(goog.ui.ButtonRenderer\|null)=`
	Button renderer; defaults to `goog.ui.ToolbarButtonRenderer` if unspecified.
`opt_domHelper`	`(goog.dom.DomHelper\|null)=`
	DOM helper, used for DOM creation; defaults to the current document if unspecified.

Returns

goog.ui.Button

A toolbar button.

VIEW SOURCE

Creates a color menu button with the given ID, tooltip, and caption. Applies any custom CSS class names to the button's caption element. The button is created with a default color menu containing standard color palettes.

Parameters

`id`	`string`
	Button ID; must equal a `goog.editor.Command` for built-in toolbar buttons, but can be anything else for custom buttons.
`tooltip`	`string`
	Tooltip to be shown on hover.
`caption`	`(string\|Node\|Array<Node>\|NodeList<Node>\|null)`
	Button caption.
`opt_classNames`	`string=`
	CSS class name(s) to apply to the caption element.
`opt_renderer`	`(goog.ui.ColorMenuButtonRenderer\|null)=`
	Button renderer; defaults to `goog.ui.ToolbarColorMenuButtonRenderer` if unspecified.
`opt_domHelper`	`(goog.dom.DomHelper\|null)=`
	DOM helper, used for DOM creation; defaults to the current document if unspecified.

Returns

goog.ui.ColorMenuButton

A color menu button.

VIEW SOURCE

Creates a menu button with the given ID, tooltip, and caption. Applies any custom CSS class names to the button's caption element. The button returned doesn't have an actual menu attached; use goog.ui.MenuButton#setMenu to attach a goog.ui.Menu to the button.

Parameters

`id`	`string`
	Button ID; must equal a `goog.editor.Command` for built-in buttons, anything else for custom buttons.
`tooltip`	`string`
	Tooltip to be shown on hover.
`caption`	`(string\|Node\|Array<Node>\|NodeList<Node>\|null)`
	Button caption.
`opt_classNames`	`string=`
	CSS class name(s) to apply to the caption element.
`opt_renderer`	`(goog.ui.ButtonRenderer\|null)=`
	Button renderer; defaults to `goog.ui.ToolbarMenuButtonRenderer` if unspecified.
`opt_domHelper`	`(goog.dom.DomHelper\|null)=`
	DOM helper, used for DOM creation; defaults to the current document if unspecified.

Returns

goog.ui.MenuButton

A menu button.

VIEW SOURCE

Creates a select button with the given ID, tooltip, and caption. Applies any custom CSS class names to the button's root element. The button returned doesn't have an actual menu attached; use goog.ui.Select#setMenu to attach a goog.ui.Menu containing goog.ui.Options to the select button.

Parameters

`id`	`string`
	Button ID; must equal a `goog.editor.Command` for built-in buttons, anything else for custom buttons.
`tooltip`	`string`
	Tooltip to be shown on hover.
`caption`	`(string\|Node\|Array<Node>\|NodeList<Node>\|null)`
	Button caption; used as the default caption when nothing is selected.
`opt_classNames`	`string=`
	CSS class name(s) to apply to the button's root element.
`opt_renderer`	`(goog.ui.MenuButtonRenderer\|null)=`
	Button renderer; defaults to `goog.ui.ToolbarMenuButtonRenderer` if unspecified.
`opt_domHelper`	`(goog.dom.DomHelper\|null)=`
	DOM helper, used for DOM creation; defaults to the current document if unspecified.

Returns

goog.ui.Select

A select button.

VIEW SOURCE

Creates a toggle button with the given ID, tooltip, and caption. Applies any custom CSS class names to the button's caption element. The button returned has checkbox-like toggle semantics.

Parameters

`id`	`string`
	Button ID; must equal a `goog.editor.Command` for built-in buttons, anything else for custom buttons.
`tooltip`	`string`
	Tooltip to be shown on hover.
`caption`	`(string\|Node\|Array<Node>\|NodeList<Node>\|null)`
	Button caption.
`opt_classNames`	`string=`
	CSS class name(s) to apply to the caption element.
`opt_renderer`	`(goog.ui.ButtonRenderer\|null)=`
	Button renderer; defaults to `goog.ui.ToolbarButtonRenderer` if unspecified.
`opt_domHelper`	`(goog.dom.DomHelper\|null)=`
	DOM helper, used for DOM creation; defaults to the current document if unspecified.

Returns

goog.ui.Button

A toggle button.

VIEW SOURCE

Creates a goog.ui.Toolbar containing the specified set of toolbar buttons, and renders it into the given parent element. Each item in the items array must a goog.ui.Control.

Parameters

`items`	`Array<(goog.ui.Control\|null)>`
	Toolbar items; each must be a `goog.ui.Control`.
`elem`	`Element`
	Toolbar parent element.
`opt_isRightToLeft`	`boolean=`
	Whether the editor chrome is right-to-left; defaults to the directionality of the toolbar parent element.

Returns

goog.ui.Toolbar

Editor toolbar, rendered into the given parent element.

VIEW SOURCE

goog.ui.editor.ToolbarFactory

Functions

addFont( `button`, `caption`, `value` ) `→` `void`

addFontSize( `button`, `caption`, `value` ) `→` `void`

addFontSizes( `button`, `sizes` ) `→` `void`

addFonts( `button`, `fonts` ) `→` `void`

addFormatOption( `button`, `caption`, `tag` ) `→` `void`

addFormatOptions( `button`, `formats` ) `→` `void`

getLegacySizeFromPx( `px` ) `→` `number`

getPrimaryFont( `fontSpec` ) `→` `string`

getPxFromLegacySize( `fontSize` ) `→` `number`

makeButton( `id`, `tooltip`, `caption`, `opt_classNames`, `opt_renderer`, `opt_domHelper` ) `→` `goog.ui.Button`

makeColorMenuButton( `id`, `tooltip`, `caption`, `opt_classNames`, `opt_renderer`, `opt_domHelper` ) `→` `goog.ui.ColorMenuButton`

makeMenuButton( `id`, `tooltip`, `caption`, `opt_classNames`, `opt_renderer`, `opt_domHelper` ) `→` `goog.ui.MenuButton`

makeSelectButton( `id`, `tooltip`, `caption`, `opt_classNames`, `opt_renderer`, `opt_domHelper` ) `→` `goog.ui.Select`

makeToggleButton( `id`, `tooltip`, `caption`, `opt_classNames`, `opt_renderer`, `opt_domHelper` ) `→` `goog.ui.Button`

makeToolbar( `items`, `elem`, `opt_isRightToLeft` ) `→` `goog.ui.Toolbar`

goog.ui.editor.ToolbarFactory

Functions

addFont( button, caption, value ) → void

addFontSize( button, caption, value ) → void

addFontSizes( button, sizes ) → void

addFonts( button, fonts ) → void

addFormatOption( button, caption, tag ) → void

addFormatOptions( button, formats ) → void

getLegacySizeFromPx( px ) → number

getPrimaryFont( fontSpec ) → string

getPxFromLegacySize( fontSize ) → number

makeButton( id, tooltip, caption, opt_classNames, opt_renderer, opt_domHelper ) → goog.ui.Button

makeColorMenuButton( id, tooltip, caption, opt_classNames, opt_renderer, opt_domHelper ) → goog.ui.ColorMenuButton

makeMenuButton( id, tooltip, caption, opt_classNames, opt_renderer, opt_domHelper ) → goog.ui.MenuButton

makeSelectButton( id, tooltip, caption, opt_classNames, opt_renderer, opt_domHelper ) → goog.ui.Select

makeToggleButton( id, tooltip, caption, opt_classNames, opt_renderer, opt_domHelper ) → goog.ui.Button

makeToolbar( items, elem, opt_isRightToLeft ) → goog.ui.Toolbar

addFont( `button`, `caption`, `value` ) `→` `void`

addFontSize( `button`, `caption`, `value` ) `→` `void`

addFontSizes( `button`, `sizes` ) `→` `void`

addFonts( `button`, `fonts` ) `→` `void`

addFormatOption( `button`, `caption`, `tag` ) `→` `void`

addFormatOptions( `button`, `formats` ) `→` `void`

getLegacySizeFromPx( `px` ) `→` `number`

getPrimaryFont( `fontSpec` ) `→` `string`

getPxFromLegacySize( `fontSize` ) `→` `number`

makeButton( `id`, `tooltip`, `caption`, `opt_classNames`, `opt_renderer`, `opt_domHelper` ) `→` `goog.ui.Button`

makeColorMenuButton( `id`, `tooltip`, `caption`, `opt_classNames`, `opt_renderer`, `opt_domHelper` ) `→` `goog.ui.ColorMenuButton`

makeMenuButton( `id`, `tooltip`, `caption`, `opt_classNames`, `opt_renderer`, `opt_domHelper` ) `→` `goog.ui.MenuButton`

makeSelectButton( `id`, `tooltip`, `caption`, `opt_classNames`, `opt_renderer`, `opt_domHelper` ) `→` `goog.ui.Select`

makeToggleButton( `id`, `tooltip`, `caption`, `opt_classNames`, `opt_renderer`, `opt_domHelper` ) `→` `goog.ui.Button`

makeToolbar( `items`, `elem`, `opt_isRightToLeft` ) `→` `goog.ui.Toolbar`