View

Example:

HomeController extends Controller {
     Index() {
         let view = new View();
         view.add(new Surface({properties: {backgroundColor: 'red'}}));
         return view
     }
}

class HomeView extends View {
     @layout.size(100, 100)
     @layout.place.center()
     mySurface = new Surface({properties: {backgroundColor: 'red'}})
}

A copy of the options that were passed in the constructor

The renderables "outputted" by the view that are passed to the underlying famous-flex layer

Adds a renderable to the layout.

Deprecated, it is no longer required to call build() from within your View instances.

Cancel a repeating renderable. This will cancel the animation for next flow-cycle, it won't interject the current animation cycle.

Returns true if the view contains uncalculated surfaces

Decorates a renderable with other decorators. Using the same decorators as used previously will override the old ones.

Example:

this.decorateRenderable('myRenderable',layout.size(100, 100));

Gets the name of a flow state of a renderable.

Gets the size used when displaying a renderable on the screen the last tick

Gets the scroll view that was set if @layout.scrollable was used on the view

getSize() is called by this view and by layoutControllers. For lazy people that don't want to specifiy their own getSize() function, we provide a fallback. This function can be performance expensive when using non-docked renderables, but for docked renderables it is efficient and convenient]

Gets the name of the flow state of a view.

Hides a renderable that has been declared with @layout.animate

Passes a callback that gets called every time the context size changes.

Gets a (new) context size of the view. This will always happen at least once immediately after the view is constructed. Hence, it can safely be used in the constructor to get the (initial) size of the view.

Example:

constructor(options){
 super(options);
 onceNewSize.then((width, height) => {
     console.log(width, height);
 });
}

Rearranges the order in which docked renderables are parsed for rendering, ensuring that 'renderableName' is processed before 'nextRenderableName'.

Reflows the layout while also informing any subscribing parents that a reflow has to take place

Removes the renderable from the view

Repeat a certain flowState indefinitely

Replaces an existing decorated renderable with a new renderable, preserving all necessary state and decorations

Initiate a renderable to a default flow state.

Sets a renderable flow state as declared in the @flow.stateStep, or @flow.defaultState

Sets a renderable flow state as declared in the @flow.viewState