Class Index | File Index

Classes


Class gui.HyperlinkController


Defined in: HyperlinkController.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
gui.HyperlinkController(session, sessionConstraints, sessionContext, inputMemberId)
Field Summary
Field Attributes Field Name and Description
<static>  
gui.HyperlinkController.enabledChanged
Method Summary
Method Attributes Method Name and Description
<inner>  
addHyperlink(hyperlink, insertionText)
Convert the current selection into a hyperlink
 
destroy(callback,)
 
<inner>  
onCursorEvent(cursor)
<inner>  
Remove all hyperlinks within the current selection.
 
subscribe(eventid, cb)
 
unsubscribe(eventid, cb)
<inner>  
Class Detail
gui.HyperlinkController(session, sessionConstraints, sessionContext, inputMemberId)
Parameters:
{!ops.Session} session
{!gui.SessionConstraints} sessionConstraints
{!gui.SessionContext} sessionContext
{!string} inputMemberId
Field Detail
<static> gui.HyperlinkController.enabledChanged
Method Detail
<inner> addHyperlink(hyperlink, insertionText)
Convert the current selection into a hyperlink
Parameters:
{!string} hyperlink
Hyperlink to insert
{!string=} insertionText
Optional text to insert as the text content for the hyperlink. Note, the insertion text will not replace the existing selection content.

{undefined} destroy(callback,)
Parameters:
{!function(!Error=)} callback,
passing an error object in case of error
Returns:
{undefined}

{!boolean} isEnabled()
Returns:
{!boolean}

<inner> {undefined} onCursorEvent(cursor)
Parameters:
{!ops.OdtCursor} cursor
Returns:
{undefined}

<inner> removeHyperlinks()
Remove all hyperlinks within the current selection. If a range of text is selected, this will only unlink the selection. If the current selection is collapsed within a link, that entire link will be removed.

{undefined} subscribe(eventid, cb)
Parameters:
{!string} eventid
{!Function} cb
Returns:
{undefined}

{undefined} unsubscribe(eventid, cb)
Parameters:
{!string} eventid
{!Function} cb
Returns:
{undefined}

<inner> {undefined} updateEnabledState()
Returns:
{undefined}

Documentation generated by JsDoc Toolkit 2.4.0 on Thu Aug 06 2015 04:10:40 GMT+0200 (MESZ)