Class Index | File Index

Classes


Class HomePane


Defined in: HomePane.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
HomePane(home, preferences, controller, controller)
Creates home view associated with its controller.
Method Summary
Method Attributes Method Name and Description
 
Returns the actions map registered with this component.
 
Returns the list of selectable items that are currently in clipboard or null if clipboard doesn't contain any selectable item.
 
Returns the HTML element used to view this component at screen.
 
Returns true if clipboard doesn't contain data that components are able to handle.
 
setEnabled(actionType, enabled)
Enables or disables the action matching actionType.
 
Enables or disables transfer between components.
 
setUndoRedoName(undoText, redoText)
Sets the NAME and SHORT_DESCRIPTION properties value of undo and redo actions.
Class Detail
HomePane(home, preferences, controller, controller)
Creates home view associated with its controller.
Author: Emmanuel Puybaret, Renaud Pawlak.
Parameters:
{Home} home
{UserPreferences} preferences
{HomeController} controller
controller
Method Detail
getActionMap()
Returns the actions map registered with this component.

{*[]} getClipboardItems()
Returns the list of selectable items that are currently in clipboard or null if clipboard doesn't contain any selectable item.
Returns:
{*[]}

getHTMLElement()
Returns the HTML element used to view this component at screen.

{boolean} isClipboardEmpty()
Returns true if clipboard doesn't contain data that components are able to handle.
Returns:
{boolean}

setEnabled(actionType, enabled)
Enables or disables the action matching actionType.
Parameters:
{HomeView.ActionType} actionType
{boolean} enabled

setTransferEnabled(enabled)
Enables or disables transfer between components.
Parameters:
{boolean} enabled

setUndoRedoName(undoText, redoText)
Sets the NAME and SHORT_DESCRIPTION properties value of undo and redo actions. If a parameter is null, the properties will be reset to their initial values.
Parameters:
{string} undoText
{string} redoText

© Copyright 2021 Emmanuel PUYBARET / eTeks
Distributed under GNU General Public License
Documentation generated by JsDoc Toolkit 2.4.0 on Tue Mar 02 2021 19:55:52 GMT+0100 (CET)