ToolbarBuilder

Backend\FormWidgets\ToolbarBuilder

Overview

ToolbarBuilder renders a visual editor for a rich editor toolbar definition, as a sortable row of button tiles with a palette of available buttons, powered client-side by the oc.richEditor registry.

Extends

Implements

Larajax\Contracts\ViewComponentInterface

Public Properties

There are no public properties in the class.

Show inherited public properties

Protected Properties

protected $defaultAlias

defaultAlias to identify this widget.

Show inherited protected properties

Public Methods

public getSaveValue()

public getSaveValue($value): void

getSaveValue stores the buttons as a comma separated string

public prepareVars()

public prepareVars(): void

prepareVars for display

public render()

public render(): void

render the widget's primary contents.

Show inherited public methods

Protected Methods

protected getInheritedButtons()

protected getInheritedButtons(): string|null

getInheritedButtons returns the configured default toolbar displayed by empty definitions, a null return means the client-side defaults apply

protected getSeededButtons()

protected getSeededButtons(): string|null

getSeededButtons returns the registered button list for the definition, used by the reset feature, a null return hides the feature

protected loadAssets()

protected loadAssets(): void

loadAssets adds widget specific asset files. Use $this->addJs() and $this->addCss() to register new assets to include on the page.

protected normalizeButtons()

protected normalizeButtons($buttons): string

normalizeButtons cleans a button list to a comma separated string of safe button codes

Show inherited protected methods

Inherited Protected Methods

combineBundledAssets() - spins over every bundle definition and combines them to an asset. (defined in Backend\Classes\WidgetBase)
emitterEventSortEvents() - sorts the listeners for a given event by priority. (defined in Backend\Classes\WidgetBase)
extendableIsAccessible() - checks if a property is accessible, property equivalent. (defined in October\Rain\Extension\Extendable)
extensionExtractImplements() - will return classes to implement. (defined in October\Rain\Extension\Extendable)
extensionExtractMethods() - extracts the available methods from a behavior and adds it. (defined in October\Rain\Extension\Extendable)
fillFromConfig() - transfers config values stored inside the $config property directly. (defined in Backend\Classes\WidgetBase)
getAssetEntryBuildPath() - is an internal marker that returns the asset path. (defined in Backend\Classes\WidgetBase)
getAssetScheme() - is an internal helper to get the asset scheme. (defined in Backend\Classes\WidgetBase)
getConfigValueFrom() - will apply the config getter convention. (defined in Backend\Classes\WidgetBase)
getExtendableMethodFromDynamicMethods() - (defined in October\Rain\Extension\Extendable)
getExtendableMethodFromExtensions() - (defined in October\Rain\Extension\Extendable)
getLocalPath() - converts a relative path to a local path. (defined in Backend\Classes\WidgetBase)
getSession() - Retrieves a widget related key/value pair from session data. (defined in Backend\Classes\WidgetBase)
handleViewException() - handles a view exception. (defined in Backend\Classes\WidgetBase)
makeSessionId() - Returns a unique session identifier for this widget and controller action. (defined in Backend\Classes\WidgetBase)
processAssetAttributes() - (defined in Backend\Classes\WidgetBase)
putSession() - Saves a widget related key/value pair in to session data. (defined in Backend\Classes\WidgetBase)
readSessionStore() - Reads the widget session store, preferring JSON and falling back to. (defined in Backend\Classes\WidgetBase)
removeDuplicateAssets() - removes duplicate and global assets from the entire collection. (defined in Backend\Classes\WidgetBase)
renderAssetAttributes() - takes an asset definition and returns the necessary HTML output. (defined in Backend\Classes\WidgetBase)

Contents