dijit/_editor/plugins/FullScreen (version 1.10)

dijit/_editor/_Plugin

Summary

This plugin provides FullScreen capability to the editor. When toggled on, it will render the editor into the full window and overlay everything. It also binds to the hotkey: CTRL-SHIFT-F11 for toggling fullscreen mode.

Usage

var foo = new FullScreen(args);
dijit/_editor/_Plugin
Parameter Type Description
args Object
Optional

Initial settings for any of the attributes.

See the dijit/_editor/plugins/FullScreen reference documentation for more information.

Property Summary

  • _origiFrameStateThe original view state of the iframe of the editor.
  • _origStateThe original view state of the editor.
  • _resizeHandleConnection point used for handling resize when window resizes.
  • buttonPointer to dijit/form/Button or other widget (ex: dijit/form/FilteringSelect) that is added to the toolbar to control this plugin.
  • commandString like "insertUnorderedList", "outdent", "justifyCenter", etc. that represents an editor command.
  • disabledFlag to indicate if this plugin has been disabled and should do nothing helps control button state, among other things.
  • editorPoints to the parent editor
  • iconClassPrefixThe CSS class name for the button node is formed from iconClassPrefix and command
  • isFullscreenRead-Only variable used to denote of the editor is in fullscreen mode or not.
  • useDefaultCommandIf true, this plugin executes by calling Editor.execCommand() with the argument specified in command.
  • zIndexzIndex value used for overlaying the full page. default is 500.

Method Summary

  • _containFocus(e) When in Full Screen mode, it's good to try and retain focus in the editor so this function is intended to try and constrain the TAB key.
  • _getAltViewNode() This function is intended as a hook point for setting an alternate view node for when in full screen mode and the editable iframe is hidden.
  • _getAttrNames(name) Helper function for get() and set().
  • _initButton() Over-ride for creation of the resize button.
  • _resizeEditor() Function to handle resizing the editor as the viewport resizes (window scaled)
  • _set(name,value) Helper function to set new value for specified attribute
  • _setDisabledAttr(disabled) Function to set the plugin state and call updateState to make sure the button is updated appropriately.
  • _setFullScreen(full) Function to handle toggling between full screen and regular view.
  • buttonClass() Class of widget (ex: dijit.form.Button or dijit/form/FilteringSelect) that is added to the toolbar to control this plugin.
  • connect(o,f,tf) Deprecated.
  • destroy() Over-ride to ensure the resize handle gets cleaned up.
  • get(name) Get a property from a plugin.
  • getLabel(key) Returns the label to use for the button
  • own() Track specified handles and remove/destroy them when this instance is destroyed, unless they were already removed/destroyed manually.
  • set(name,value) Set a property on a plugin
  • setEditor(editor) Over-ride for the setting of the editor.
  • setToolbar(toolbar) Tell the plugin to add it's controller widget (often a button) to the toolbar.
  • toggle() Function to allow programmatic toggling of the view.
  • updateState() Over-ride for button state control for disabled to work.

Properties

_origiFrameState

The original view state of the iframe of the editor.

_origState

The original view state of the editor.

_resizeHandle

Connection point used for handling resize when window resizes.

button
Defined by: dijit/_editor/_Plugin

Pointer to dijit/form/Button or other widget (ex: dijit/form/FilteringSelect) that is added to the toolbar to control this plugin. If not specified, will be created on initialization according to buttonClass

command
Defined by: dijit/_editor/_Plugin

String like "insertUnorderedList", "outdent", "justifyCenter", etc. that represents an editor command. Passed to editor.execCommand() if useDefaultCommand is true.

disabled
Defined by: dijit/_editor/_Plugin

Flag to indicate if this plugin has been disabled and should do nothing helps control button state, among other things. Set via the setter api.

editor
Defined by: dijit/_editor/_Plugin

Points to the parent editor

iconClassPrefix
Defined by: dijit/_editor/_Plugin

The CSS class name for the button node is formed from iconClassPrefix and command

isFullscreen

Read-Only variable used to denote of the editor is in fullscreen mode or not.

useDefaultCommand
Defined by: dijit/_editor/_Plugin

If true, this plugin executes by calling Editor.execCommand() with the argument specified in command.

zIndex

zIndex value used for overlaying the full page. default is 500.

Methods

_containFocus(e)

When in Full Screen mode, it's good to try and retain focus in the editor so this function is intended to try and constrain the TAB key.

Parameter Type Description
e Event

The key event.

_getAltViewNode()

This function is intended as a hook point for setting an alternate view node for when in full screen mode and the editable iframe is hidden.

_getAttrNames(name)

Helper function for get() and set(). Caches attribute name values so we don't do the string ops every time.

Parameter Type Description
name undefined
Returns:undefined | object
_initButton()

Over-ride for creation of the resize button.

_resizeEditor()

Function to handle resizing the editor as the viewport resizes (window scaled)

_set(name,value)

Helper function to set new value for specified attribute

Parameter Type Description
name String
value anything
_setDisabledAttr(disabled)

Function to set the plugin state and call updateState to make sure the button is updated appropriately.

Parameter Type Description
disabled undefined
_setFullScreen(full)

Function to handle toggling between full screen and regular view.

Parameter Type Description
full undefined
buttonClass()

Class of widget (ex: dijit.form.Button or dijit/form/FilteringSelect) that is added to the toolbar to control this plugin. This is used to instantiate the button, unless button itself is specified directly.

connect(o,f,tf)

Deprecated. Use this.own() with dojo/on or dojo/aspect.instead.

Make a connect.connect() that is automatically disconnected when this plugin is destroyed. Similar to dijit/_Widget.connect().

Parameter Type Description
o undefined
f undefined
tf undefined
destroy()

Over-ride to ensure the resize handle gets cleaned up.

get(name)

Get a property from a plugin.

Get a named property from a plugin. The property may potentially be retrieved via a getter method. If no getter is defined, this just retrieves the object's property. For example, if the plugin has a properties "foo" and "bar" and a method named "_getFooAttr", calling:

plugin.get("foo");

would be equivalent to writing:

plugin._getFooAttr();

and:

plugin.get("bar");

would be equivalent to writing:

plugin.bar;
Parameter Type Description
name undefined

The property to get.

Returns:undefined
getLabel(key)

Returns the label to use for the button

Parameter Type Description
key String
Returns:undefined
own()
Defined by dijit/Destroyable

Track specified handles and remove/destroy them when this instance is destroyed, unless they were already removed/destroyed manually.

Returns:any | undefined

The array of specified handles, so you can do for example:

var handle = this.own(on(...))[0];
set(name,value)

Set a property on a plugin

Sets named properties on a plugin which may potentially be handled by a setter in the plugin. For example, if the plugin has a properties "foo" and "bar" and a method named "_setFooAttr", calling:

plugin.set("foo", "Howdy!");

would be equivalent to writing:

plugin._setFooAttr("Howdy!");

and:

plugin.set("bar", 3);

would be equivalent to writing:

plugin.bar = 3;

set() may also be called with a hash of name/value pairs, ex:

plugin.set({
    foo: "Howdy",
    bar: 3
})

This is equivalent to calling set(foo, "Howdy") and set(bar, 3)

Parameter Type Description
name attribute

The property to set.

value anything

The value to set in the property.

Returns:function | string

Set a property on a plugin

setEditor(editor)

Over-ride for the setting of the editor.

Parameter Type Description
editor Object

The editor to configure for this plugin to use.

setToolbar(toolbar)

Tell the plugin to add it's controller widget (often a button) to the toolbar. Does nothing if there is no controller widget.

Parameter Type Description
toolbar dijit/Toolbar
toggle()

Function to allow programmatic toggling of the view.

updateState()

Over-ride for button state control for disabled to work.

Error in the documentation? Can’t find what you are looking for? Let us know!