Aloha class

Constructors

Aloha()
A binding class for the Aloha HTML5 editor. Refer to the accompanying documentation for setup and usage information. Omissions from the Aloha API are also documented.

Properties

activeEditable AlohaEditable?
Currently active editable as an AlohaEditable
no setter
blockSelectedEvent Stream
no setter
commandExecutedEvent Stream
no setter
commandWillExecuteEvent Stream
no setter
context JsObject?
no setter
ddfAllFilesPreparedEvent Stream
no setter
ddfFilesDroppedInPageEvent Stream
no setter
ddfFileUploadPreparedEvent Stream
no setter
defaults JsObject?
Defaults Hardwired startup defaults.
no setter
editableActivatedEvent Stream
no setter
editableCreatedEvent Stream
no setter
editableDeactivatedEvent Stream
no setter
editableDestroyedEvent Stream
no setter
editables List<AlohaEditable>?
List of currently maintained editables as a List of AlohaEditable's.
no setter
hashCode int
The hash code for this object.
no setterinherited
imageSelectedEvent Stream
no setter
imageUnselectedEvent Stream
no setter
isReady bool
getter/setter pair
linkSelectedEvent Stream
no setter
linkUnselectedEvent Stream
no setter
loadedPlugins JsObject?
Loaded plugins, returned a list of plugin name strings
no setter
loggerFullEvent Stream
no setter
loggerReadyEvent Stream
no setter
osName String?
OS name
no setter
readyEvent Stream
no setter
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
settings JsObject?
Settings We have no way of knowing what settings have been applied to Aloha in its js startup so you need to know the settings structure on the client side.
no setter
smartContentChangeEvent Stream
no setter
tableActivatedEvent Stream
no setter
tableSelectionChangedEvent Stream
no setter
version String?
Version string
no setter

Methods

activateEditable(AlohaEditable editable) → void
Activate the specified editable, also deactivates all other editables.
attachEditable(String selector) → void
Attach jQuery selectors to Aloha to make them editable entities.
deactivateActiveEditable() → void
Deactivate the active editable
detachEditable(String selector) → void
Detach jQuery selectors from Aloha to make previous editables non-editable entities. If they were previously editable they will be destroyed.
disableObjectResizing() → void
Disable object resizing if the browser supports this.
execCommand(String commandId, {bool showUi = false, String? value}) → void
execCommand implements the commands from the commmand manager section See the relevant Mozilla documentation here for details. https://developer.mozilla.org/en/docs/Rich-Text_Editing_in_Mozilla
getActiveEditable() AlohaEditable?
Get the active editable, null if none active
getEditableById(String id) AlohaEditable?
Get an editable by its id attribute, returns null if none found
getEditableHost(HtmlElement element) AlohaEditable?
Get editable host.
getPluginUrl(String name) String?
Gets a plugin's url.
getUrl() String?
Get the Aloha url.
isAnEditable(Object? anyObject) bool
Check if an object is an editable.
isPluginLoaded(String pluginName) bool?
Is a plugin loaded
log(String level, String component, String message) → void
Logs a message to the console.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
queryCommandEnabled(String commandId) bool?
Query command enabled.
queryCommandSupported(String commandId) bool?
Query command supported.
queryCommandValue(String commandId) String?
Return the commands value.
querySupportedCommands() List?
Query supported commands.
registerEditable(AlohaEditable editable) → void
Register an editable.
reinitialise() → void
Initialization Use to set Aloha back to its original state
toString() String
To string override
override
unregisterEditable(AlohaEditable editable) → void
Unregister an editable.

Operators

operator ==(Object other) bool
The equality operator.
inherited