Package org.uberfire.client.mvp

Interface PerspectiveActivity

All Superinterfaces:

Activity, ContextSensitiveActivity, org.uberfire.security.Resource, org.uberfire.security.authz.RuntimeFeatureResource, org.uberfire.security.authz.RuntimeResource

All Known Implementing Classes:

AbstractWorkbenchPerspectiveActivity, StandaloneEditorPerspective

@JsType
public interface PerspectiveActivity
extends ContextSensitiveActivity

Method Summary

Modifier and Type	Method	Description
org.uberfire.workbench.model.PerspectiveDefinition	getDefaultPerspectiveLayout()	Returns a new copy of the layout (panels and their parts) that should be used if no persisted state is available.
void	getMenus(Consumer<org.uberfire.workbench.model.menu.Menus> menusConsumer)	Returns a new copy of the menus that should be used with this perspective.
default String	getName()	Returns the name of this activity, defaulting to Resource.getIdentifier().
org.uberfire.workbench.model.toolbar.ToolBar	getToolBar()
boolean	isDefault()	Returns true if this perspective should be displayed automatically when the application starts.
boolean	isTransient()	Tells whether this perspective's state (layout and size of panels, parts contained in each panel) should be saved per user or not.

Methods inherited from interface org.uberfire.client.mvp.Activity

getPlace, isDynamic, onClose, onOpen, onShutdown, onStartup

Methods inherited from interface org.uberfire.security.Resource

getDependencies, getIdentifier, getResourceType, isType

Method Detail

getDefaultPerspectiveLayout

org.uberfire.workbench.model.PerspectiveDefinition getDefaultPerspectiveLayout()

Returns a new copy of the layout (panels and their parts) that should be used if no persisted state is available. Each time this method is called, it must produce a new PerspectiveDefinition. This rule applies whether or not the perspective is transient.

Returns:

the perspective layout to use when a previously saved one is not available.

See Also:

isTransient(), WorkbenchServicesProxy.loadPerspective(String, org.uberfire.mvp.ParameterizedCommand)

getName

default String getName()

Description copied from interface: Activity

Returns the name of this activity, defaulting to Resource.getIdentifier().

Specified by:

getName in interface Activity

Returns:

the activity's name

isDefault

boolean isDefault()

Returns true if this perspective should be displayed automatically when the application starts. Each application needs exactly one default perspective.

Specified by:

isDefault in interface Activity

Returns:

true if this is the default perspective; false if it is not.

getMenus

void getMenus(Consumer<org.uberfire.workbench.model.menu.Menus> menusConsumer)

Returns a new copy of the menus that should be used with this perspective. Each time this method is called, it must produce a new set of menus.

getToolBar

org.uberfire.workbench.model.toolbar.ToolBar getToolBar()

isTransient

boolean isTransient()

Tells whether this perspective's state (layout and size of panels, parts contained in each panel) should be saved per user or not.

Returns:

false if this perspective's state should be saved and retrieved from the server; true if this perspective should always start up in its default layout.

See Also:

WorkbenchServicesProxy.loadPerspective(String, org.uberfire.mvp.ParameterizedCommand)