Class orion.editor.TextTheme

A TextTheme is a class used to specify an editor theme.
Defined in: </shared/eclipse/e4/orion/I201404012230/bundles/org.eclipse.orion.client.editor/web/orion/editor/textTheme.js>.

Class Summary
Constructor Attributes	Constructor Name and Description
	orion.editor.TextTheme() Constructs a new text theme.

Method Summary
Method Attributes	Method Name and Description
	addEventListener(type, listener, useCapture) Adds an event listener to this event target.
	dispatchEvent(evt) Dispatches the given event to the listeners added to this event target.
	getThemeClass() Returns the theme className.
	removeEventListener(type, listener, useCapture) Removes an event listener from the event target.
	setThemeClass(className, styleSheet) Sets the theme className and style sheet.

Event Summary
Event Attributes	Event Name and Description
	onThemeChanged(themeChangedEvent) This event is sent when the theme clasName has changed and its style sheet has been loaded in the document.

Class Detail

orion.editor.TextTheme()

Constructs a new text theme.

Method Detail

addEventListener(type, listener, useCapture)

Adds an event listener to this event target.
Defined in: </shared/eclipse/e4/orion/I201404012230/bundles/org.eclipse.orion.client.editor/web/orion/editor/eventTarget.js>.

Parameters:
{String} type: The event type.
{Function|EventListener} listener: The function or the EventListener that will be executed when the event happens.
{Boolean} useCapture Optional, Default: false: true if the listener should be trigged in the capture phase.

See:: orion.editor.EventTarget#removeEventListener

dispatchEvent(evt)

Dispatches the given event to the listeners added to this event target.
Defined in: </shared/eclipse/e4/orion/I201404012230/bundles/org.eclipse.orion.client.editor/web/orion/editor/eventTarget.js>.

Parameters:
{Event} evt: The event to dispatch.

getThemeClass()

Returns the theme className.

See:: orion.editor.TextTheme#setThemeClass

removeEventListener(type, listener, useCapture)

Removes an event listener from the event target.

All the parameters must be the same ones used to add the listener.

Defined in: </shared/eclipse/e4/orion/I201404012230/bundles/org.eclipse.orion.client.editor/web/orion/editor/eventTarget.js>.

Parameters:
{String} type: The event type
{Function|EventListener} listener: The function or the EventListener that will be executed when the event happens.
{Boolean} useCapture Optional, Default: false: true if the listener should be trigged in the capture phase.

See:: orion.editor.EventTarget#addEventListener

setThemeClass(className, styleSheet)

Sets the theme className and style sheet.

If the stylesheet parameter is a string, it represents an inline CSS and it will be added to the document as a STYLE tag element. If the stylesheet parameter is a orion.editor.ThemeStyleSheet, its href property is loaded as either a STYLE tag element or as a LINK tag element.

Listeners of the ThemeChanged event are notify once the styled sheet is loaded into the document.

Parameters:
{String} className: the new theme className.
{String|orion.editor.ThemeStyleSheet} styleSheet: the CSS stylesheet for the new theme className.

See:: orion.editor.TextTheme#getThemeClass; orion.editor.TextTheme#onThemeChanged

Event Detail

onThemeChanged(themeChangedEvent)

This event is sent when the theme clasName has changed and its style sheet has been loaded in the document.

Parameters:
{orion.editor.ThemeChangedEvent} themeChangedEvent: the event

Classes

Class orion.editor.TextTheme