Home | Class Index

SDK Version: 3.11.4-302512

Documentation generated on 24 July 2015

Class
caplin.menu.presenter.node

Menu

A PresentationNode which will serve as the control node for the caplin.menu.presenter.Control.

The caplin.menu.presenter.node.Menu uses any implementation of caplin.menu.model.Item as the model to render the menu. If you have chosen to implement your own menu and control (see caplin.menu.Control), you can provide your own model in the constructor. If you do not do so, a standard caplin.menu.model.Menu will be created which can then be retrieved using #getMenuModel.

Constructor Summary

Attributes Name and Description
caplin.menu.presenter.node.Menu(caplin.menu.model.Item model)

Constructs a new instance of PresentationNode.

Method Summary

Attributes Name and Description
void addGenerator(caplin.menu.Generator generator, String type)

Allows the user to add custom generators into the caplin.menu.Control.
void getGenerators()

Returns a map with the types as the keys and the generator instances as the values.
void getMenuModel()

Returns the model.
void hide()

Informs the control to hide the menu.
void isVisible()

Returns the value of the visible property.
void setMenuModel( model)

Sets the model.
void show()

Informs the control to show the menu.

Constructor Detail

► caplin.menu.presenter.node.Menu(caplin.menu.model.Item model)

Constructs a new instance of PresentationNode.

Parameters
caplin.menu.model.Item model The model used for the by the control to render the menu.

Method Detail

► void addGenerator(caplin.menu.Generator generator, String type)

Allows the user to add custom generators into the caplin.menu.Control. See caplin.menu.Control#addGenerator for more details.

Parameters
caplin.menu.Generator generator Generator class which will render elements of the given type.
String type String representation of the item type the control registered will be in charge of rendering.

► void getGenerators()

Returns a map with the types as the keys and the generator instances as the values.

► void getMenuModel()

Returns the model.

► void hide()

Informs the control to hide the menu.

► void isVisible()

Returns the value of the visible property.

► void setMenuModel( model)

Sets the model.

Parameters
model

► void show()

Informs the control to show the menu.