de.felixroske.jfxsupport.FXMLView Maven / Gradle / Ivy

Go to download
package de.felixroske.jfxsupport;

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

import org.springframework.stereotype.Component;

import javafx.stage.StageStyle;

/**
 * The annotation {@link FXMLView} indicates a class to be used in the context
 * of an JavaFX view. Such classes are used in combination with fxml markup
 * files.
 *
 * @author Felix Roske
 */
@Component
@Retention(RetentionPolicy.RUNTIME)
public @interface FXMLView {

	/**
	 * Value refers to a relative path from where to load a certain fxml file.
	 *
	 * @return the relative file path of a views fxml file.
	 */
	String value() default "";

	/**
	 * Css files to be used together with this view.
	 *
	 * @return the string[] listing all css files.
	 */
	String[] css() default {};

	/**
	 * Resource bundle to be used with this view.
	 *
	 * @return the string of such resource bundle.
	 */
	String bundle() default "";
	
	/**
	 * The default title for this view for modal.
	 * 
	 * @return The default title string.
	 */
	String title() default "";
	
	/**
	 * The style to be applied to the underlying stage 
	 * when using this view as a modal window.
	 */
	String stageStyle() default "UTILITY";
}