Package org.onosproject.ui

Class UiExtension

java.lang.Object

org.onosproject.ui.UiExtension

public final class UiExtension
extends Object

Immutable representation of a user interface extension.

Note that the UiExtension.Builder class is used to create a user interface extension instance, and that these instances are immutable.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UiExtension.Builder	UI Extension Builder.

Method Summary

Modifier and Type	Method	Description
InputStream	css()	Returns input stream containing CSS inclusion statements.
InputStream	js()	Returns input stream containing JavaScript inclusion statements.
List<LionBundle>	lionBundles()	Returns the list of localization bundles that this extension is contributing.
UiMessageHandlerFactory	messageHandlerFactory()	Returns message handler factory, if one was defined.
InputStream	resource(String viewId, String path)	Returns input stream containing specified view-specific resource.
UiTopo2OverlayFactory	topo2OverlayFactory()	Returns the topology-2 overlay factory, if one was defined.
UiTopoMapFactory	topoMapFactory()	Returns the topology map factory, if one was defined.
UiTopoOverlayFactory	topoOverlayFactory()	Returns the topology overlay factory, if one was defined.
List<UiView>	views()	Returns list of user interface views contributed by this extension.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

css

public InputStream css()

Returns input stream containing CSS inclusion statements.

Returns:

CSS inclusion statements

js

public InputStream js()

Returns input stream containing JavaScript inclusion statements.

Returns:

JavaScript inclusion statements

views

public List<UiView> views()

Returns list of user interface views contributed by this extension.

Returns:

contributed view descriptors

lionBundles

public List<LionBundle> lionBundles()

Returns the list of localization bundles that this extension is contributing.

Returns:

contributed localization bundles

resource

public InputStream resource(String viewId,
                            String path)

Returns input stream containing specified view-specific resource.

Parameters:

viewId - view identifier

path - resource path, relative to the view directory

Returns:

resource input stream

messageHandlerFactory

public UiMessageHandlerFactory messageHandlerFactory()

Returns message handler factory, if one was defined.

Returns:

message handler factory

topoOverlayFactory

public UiTopoOverlayFactory topoOverlayFactory()

Returns the topology overlay factory, if one was defined.

Returns:

topology overlay factory

topo2OverlayFactory

public UiTopo2OverlayFactory topo2OverlayFactory()

Returns the topology-2 overlay factory, if one was defined.

Returns:

topology-2 overlay factory

topoMapFactory

public UiTopoMapFactory topoMapFactory()

Returns the topology map factory, if one was defined.

Returns:

topology map factory