org.onosproject.ui

Class UiExtension

java.lang.Object

org.onosproject.ui.UiExtension

public class UiExtension
extends Object

User interface extension.

Constructor Summary

Constructors

Constructor and Description
UiExtension(List<UiView> views, UiMessageHandlerFactory messageHandlerFactory, ClassLoader classLoader) Creates a user interface extension for loading CSS and JS injections from css.html and js.html resources, respectively.
UiExtension(List<UiView> views, UiMessageHandlerFactory messageHandlerFactory, String path, ClassLoader classLoader) Creates a user interface extension using custom resource prefix.

Method Summary

Modifier and Type	Method and Description
InputStream	css() Returns input stream containing CSS inclusion statements.
InputStream	js() Returns input stream containing JavaScript inclusion statements.
UiMessageHandlerFactory	messageHandlerFactory() Returns message handler factory.
InputStream	resource(String viewId, String path) Returns input stream containing specified view-specific resource.
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

Constructor Detail

UiExtension

public UiExtension(List<UiView> views,
                   UiMessageHandlerFactory messageHandlerFactory,
                   ClassLoader classLoader)

Creates a user interface extension for loading CSS and JS injections from css.html and js.html resources, respectively.

Parameters:

views - list of contributed views

messageHandlerFactory - optional message handler factory

classLoader - class-loader for user interface resources

UiExtension

public UiExtension(List<UiView> views,
                   UiMessageHandlerFactory messageHandlerFactory,
                   String path,
                   ClassLoader classLoader)

Creates a user interface extension using custom resource prefix. It loads CSS and JS injections from path/css.html and prefix/js.html resources, respectively.

Parameters:

views - list of user interface views

messageHandlerFactory - optional message handler factory

path - resource path prefix

classLoader - class-loader for user interface resources

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

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.

Returns:

message handlers