org.nuxeo.ecm.gwt.runtime.client.ui.view
Interface ViewManager

All Known Implementing Classes:

DefaultViewManager, MultiPageViewManager

public interface ViewManager

Author:

Bogdan Stefanescu

Method Summary

void	activateView(java.lang.String id) Activates a view given its ID.
void	addView(java.lang.String id, View view) Registers a view under an id.
void	deactivateView(java.lang.String id) Deactivates a view given its ID.
View	getActiveView() Gets the current view.
Container	getContainer() The site manager used by this view.
View	getView(java.lang.String id) Gets a view given its registration ID.
View[]	getViews() Gets all registered views.
int	getViewsCount() Gets the number of the view in that manager.
void	hideView(java.lang.String id) Hides a view given its registration ID.
void	open(java.lang.Object input) Opens the given view.
void	removeView(View view) Removes a registered view.
void	setContainer(Container mgr) Sets the site manager to be used by this view manager.
void	showView(java.lang.String id) Shows a view given its registration ID.

Method Detail

setContainer

void setContainer(Container mgr)

Sets the site manager to be used by this view manager.

getContainer

Container getContainer()

The site manager used by this view.

Returns:

the site manager

open

void open(java.lang.Object input)

Opens the given view. The managed views are refreshed depending on the input so that you may expect that some views becomes hidden or restored after an open operation.

Parameters:

input - (may be null)

showView

void showView(java.lang.String id)

Shows a view given its registration ID. If view is already visible, do nothing.

hideView

void hideView(java.lang.String id)

Hides a view given its registration ID. If view is already hidden, do nothing. This method may not apply for deck style containers (e.g. multi-page views) which are showing only one view at a time. In this case calling showView() on another view will hide the active view. For other container types, it does nothing.

activateView

void activateView(java.lang.String id)

Activates a view given its ID. This will make visible the view content (similar to expand for stack views or select for deck views).

deactivateView

void deactivateView(java.lang.String id)

Deactivates a view given its ID. This will hide the content of the view (similar to collapse for stack views or deselect for deck views).

getActiveView

View getActiveView()

Gets the current view. This method applies only for deck style containers (e.g. that are showing only one view at a time). For other container type it does nothing.

Returns:

the active view or null if none.

addView

void addView(java.lang.String id,
             View view)

Registers a view under an id.

Parameters:

id - the view id

view - the view to register

removeView

void removeView(View view)

Removes a registered view.

Parameters:

view - the view to remove

getViews

View[] getViews()

Gets all registered views.

Returns:

all registered views or an empty array if none.

getViewsCount

int getViewsCount()

Gets the number of the view in that manager.

getView

View getView(java.lang.String id)

Gets a view given its registration ID.