org.nuxeo.ecm.gwt.runtime.client.ui
Interface View

All Superinterfaces:

Drawable

All Known Implementing Classes:

AbstractView, AdministrationView, ClipboardView, DocumentMetadataView, DocumentView, FolderView, Footer, Header, MultiPageDocView, NavigatorView, Right, SearchEditor.SearchView, SmartView, ViewStack

public interface View
extends Drawable

Author:

Bogdan Stefanescu

Method Summary

boolean	acceptInput(java.lang.Object input) Whether or not this view accepts the given input.
java.lang.String	getIcon() Gets a icon suitable for this view.
java.lang.Object	getInput() Gets the current input if the view if any.
java.lang.String	getName() Gets the view name the view an can be used to find out a view from its container.
java.lang.String	getTitle() Gets a title suitable for this view.
boolean	hasWidget() Whether or not the view widget was created.
void	hideBusy() Hides busy state.
void	install(Site site, java.lang.Object input) Installs the view into a site and sets is input to the given one.
boolean	isInstalled() Whether or not this view is installed into a site (its widget was created).
void	refresh() Refreshes this view using current input.
void	setInput(java.lang.Object input) Sets the input object for the view.
void	showBusy() Shows busy state.
void	uninstall() Uninstalls the view from its site.

Methods inherited from interface org.nuxeo.ecm.gwt.runtime.client.ui.Drawable

getWidget

Method Detail

install

void install(Site site,
             java.lang.Object input)

Installs the view into a site and sets is input to the given one. The view widget will be created at this point after setting the input.

Parameters:

site - the site to host the view

input - the input object

uninstall

void uninstall()

Uninstalls the view from its site. All cached data should be removed such as the view widget etc. The view itself should not be destroyed to be able to re-install it later if needed.

isInstalled

boolean isInstalled()

Whether or not this view is installed into a site (its widget was created).

Returns:

true if installed, false otherwise.

hasWidget

boolean hasWidget()

Whether or not the view widget was created.

getName

java.lang.String getName()

Gets the view name the view an can be used to find out a view from its container.

getTitle

java.lang.String getTitle()

Gets a title suitable for this view. This is a hint to the site view ad should reflect the current view input.

Returns:

the title or null if none

getIcon

java.lang.String getIcon()

Gets a icon suitable for this view. This is a hint to the view site and should reflect the current view input.

Returns:

the icon or null if none

refresh

void refresh()

Refreshes this view using current input. This should be called by a setInput after setting the input. Optional operation - if container doesn't supports refresh do nothing

showBusy

void showBusy()

Shows busy state. Called when busy state is required.

hideBusy

void hideBusy()

Hides busy state. Called when busy state terminated.

acceptInput

boolean acceptInput(java.lang.Object input)

Whether or not this view accepts the given input. This is an optional operation and should return false if not supported

Returns:

true if input can be rendered by the view

setInput

void setInput(java.lang.Object input)

Sets the input object for the view. This is an optional operation and should be implemented only by views that supports input (e.g. editors)

getInput

java.lang.Object getInput()

Gets the current input if the view if any.

Returns:

the input if any input or null if none