org.uberfire.client.annotations.WorkbenchPopup 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 Workbench popups.
*
* At its simplest form the Class should extend
* {@code com.google.gwt.user.client.ui.PopupPanel} and provide a method
* annotated with {@code @OnOpen}.
*
*
* Developers wishing to separate view from logic (perhaps by implementing the
* MVP pattern) can further provide a zero-argument method annotated with
* {@code @WorkbenchPartView} with return type
* {@code com.google.gwt.user.client.ui.PopupPanel}.
*
*
* In this latter case the {@code @WorkbenchPopup} need not extend
* {@code com.google.gwt.user.client.ui.PopupPanel}.
*
*
* WorkbechPopups can receive the following life-cycle calls:
*
* - {@code @OnOpen}
*
*/
@Inherited
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE})
public @interface WorkbenchPopup {
String identifier();
WorkbenchPopupSize size() default WorkbenchPopupSize.MEDIUM;
enum WorkbenchPopupSize {
SMALL,
MEDIUM,
LARGE
}
}