Interface Sample

fxsampler/src/main/java/fxsampler/Sample.java:34–101

/**
 */
public interface Sample {

    /**
     * A short, most likely single-word, name to show to the user - e.g. "CheckBox"
     */
    String getSampleName();

    /**
     * A short, multiple sentence description of the sample.
     */
    String getSampleDescription();

    /**
     * Returns the name of the project that this sample belongs to (e.g. 'JFXtras'
     * or 'ControlsFX').
     */
    String getProjectName();

    /**
     * Returns the version of the project that this sample belongs to (e.g. '1.0.0')
     */
    String getProjectVersion();

    /**
     * Returns the main sample panel.
     */
    Node getPanel(final Stage stage);

    /**
     * Returns the panel to display to the user that allows for manipulating
     * the sample.
     */
    Node getControlPanel();

    /**
     * Provides a place to dispose of any resources when sample is deselected
     */
    void dispose();


    /**
     * Returns divider position to use for split between main panel and control panel
     */
    double getControlPanelDividerPosition();

    /**
     * A full URL to the javadoc for the API being demonstrated in this sample.
     */
    String getJavaDocURL();

    /**
     * Returns URL for control's stylesheet.
     * If the CSS resource is available on module-path,
     * {@link FXSamplerProject#getModuleName() project's} module name should be defined.
     */
    String getControlStylesheetURL();

    /**