org.uberfire.client.annotations.WorkbenchScreen Maven / Gradle / Ivy
/*
* Copyright 2015 Red Hat, Inc. and/or its affiliates.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.uberfire.client.annotations;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* 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 {@code @WorkbenchEditor}.
*
* All classes annotated with {@code @WorkbenchScreen} must have a declared or inherited method annotated with
* {@code @WorkbenchPartTitle}.
*
* There are two options for providing the screen's view:
*
* - the class implements {@code com.google.gwt.user.client.ui.IsWidget} (often by extending {@code com.google.gwt.user.client.ui.Composite})
*
- the class declares or inherits a zero-argument method annotated with {@code @WorkbenchPartView} that returns the
* {@code com.google.gwt.user.client.ui.IsWidget} that handles the view. In this case the class need not implement
* {@code com.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:
*
* - {@code @OnStartup}
* - {@code @OnOpen}
* - {@code @OnFocus}
* - {@code @OnLostFocus}
* - {@code @OnMayClose}
* - {@code @OnClose}
* - {@code @OnShutdown}
*
*/
@Inherited
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.TYPE })
public @interface WorkbenchScreen {
/**
* Identifier that should be unique within application.
*/
String identifier();
/**
* 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.
*/
Class owningPerspective() default void.class;
/**
* Defines the preferred height. Preferred means that this Height will be used only if this screen
* is the trigger to create a new panel, if panel already exists this information is ignored.
*/
int preferredHeight() default -1;
/**
* Defines the preferred width. Preferred means that this Width will be used only if this screen
* is the trigger to create a new panel, if panel already exists this information is ignored.
*/
int preferredWidth() default -1;
}