org.liquidplayer.service

Interface Surface

All Known Implementing Classes:

ConsoleSurface

public interface Surface

A Surface is a UI interaction layer with a MicroService.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Surface.ReportErrorRunnable A runnable to be called in the event of an error.

Method Summary

Modifier and Type	Method and Description
android.view.View	attach(MicroService service, java.lang.Runnable onAttached, Surface.ReportErrorRunnable onError) Attaches a MicroService to the UI.
void	bind(MicroService service, JSContext context, JSObject export, JSValue config, java.lang.Runnable onBound, Surface.ReportErrorRunnable onError) Binds a surface to a MicroService.
void	detach() Detaches any currently attached MicroService.
void	reset() Detaches and clears the Surface.

Method Detail

bind

void bind(MicroService service,
          JSContext context,
          JSObject export,
          JSValue config,
          java.lang.Runnable onBound,
          Surface.ReportErrorRunnable onError)

Binds a surface to a MicroService. This gives the surface an opportunity to bind any native functions required by the module.

Parameters:

service - The microservice on which to bind

context - The Javascript context on which to bind

export - An object which will be passed back to the caller where the surface may export its JS bindings

config - An optional configuration parameter passed from JavaScript

onBound - A runnable which must be called once binding is complete

onError - A runnable which should be called if binding fails

attach

android.view.View attach(MicroService service,
                         java.lang.Runnable onAttached,
                         Surface.ReportErrorRunnable onError)

Attaches a MicroService to the UI.

Parameters:

service - The MicroService to attach

onAttached - A runnable to be called after the UI is active

onError - A runnable which should be called if attaching fails

detach

void detach()

Detaches any currently attached MicroService. The Surface may then be ready to be discarded or reattached.

reset

void reset()

Detaches and clears the Surface. This is the preferred method when the Surface is to be reused. detach() may leave behind some UI state, as it expects that the MicroService may later be re-attached. reset() clears any UI state back to a fresh state.