Package org.uberfire.client.annotations
Annotation Type WorkbenchScreen
-
@Inherited @Retention(RUNTIME) @Target(TYPE) public @interface WorkbenchScreen
Classes annotated with this are considered WorkbenchParts that display some form of non-editable (but possibly still interactive) content. If the content is associated with a VFS path, or otherwise represents some sort of document that can be edited and saved, developers should consider using@WorkbenchEditor.All classes annotated with
@WorkbenchScreenmust have a declared or inherited method annotated with@WorkbenchPartTitle.There are two options for providing the screen's view:
- the class implements
com.google.gwt.user.client.ui.IsWidget(often by extendingcom.google.gwt.user.client.ui.Composite) - the class declares or inherits a zero-argument method annotated with
@WorkbenchPartViewthat returns thecom.google.gwt.user.client.ui.IsWidgetor preferablyorg.jboss.errai.common.client.api.IsElementthat handles the view. In this case the class need not implementcom.google.gwt.user.client.ui.IsWidget.
Developers wishing to separate view from logic via the MVP pattern will choose the second option.
WorkbechScreens can receive the following life-cycle calls:
@OnStartup@OnOpen@OnFocus@OnLostFocus@OnMayClose@OnClose@OnShutdown
- the class implements
-
-
Required Element Summary
Required Elements Modifier and Type Required Element Description StringidentifierIdentifier that should be unique within application.
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description booleanisDynamicIndicates that this screen can be discovered and loaded at runtime.Class<?>owningPerspectiveBy default, a Workbench Screen will show up in the current active perspective.intpreferredHeightDefines the preferred height.intpreferredWidthDefines the preferred width.
-
-
-
Element Detail
-
identifier
String identifier
Identifier that should be unique within application.
-
-
-
owningPerspective
Class<?> owningPerspective
By default, a Workbench Screen will show up in the current active perspective. If this parameter is specified, this screen will only be shown on the given perspective. An attempt to navigate to this screen when a different perspective is active will first result in a switch to the owning perspective, then the screen will be shown in that perspective.- Default:
- void.class
-
-