org.jacpfx.api.annotations.perspective.Perspective Maven / Gradle / Ivy
/************************************************************************
*
* Copyright (C) 2010 - 2014
*
* [Perspective.java]
* JACPFX Project (https://github.com/JacpFX/JacpFX/)
* All rights reserved.
*
* 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.jacpfx.api.annotations.perspective;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Defines the meta attributes for a perspective.
*
* @author Andy Moncsek
*/
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface Perspective {
/**
* The perspective name.
*
* @return The perspective name.
*/
String name();
/**
* The perspective id.
*
* @return The perspective Id
*/
String id();
/**
* The active state at start time.
*
* @return boolean
*/
boolean active() default true;
/**
* Represents the location (URI) of the declarative UI.
*
* @return The view location (like bundle.messages)
*/
String viewLocation() default "";
/**
* Represents the location of your resource bundle file.
*
* @return The default resource bundle location (like bundle.messages)
*/
String resourceBundleLocation() default "";
/**
* Represents the Locale ID. see: http://www.oracle.com/technetwork/java/javase/locales-137662.html
*
* @return The default locale Id
*/
String localeID() default "";
/**
* Define all component id's which belongs to perspective.
*
* @return all related component ids
*/
String[] components();
}