eu.agrosense.api.widget.Widget Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of widget Show documentation
The newest version!
/**
 * Copyright (C) 2008-2013 LimeTri. All rights reserved.
 *
 * AgroSense is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * There are special exceptions to the terms and conditions of the GPLv3 as it is applied to
 * this software, see the FLOSS License Exception
 * .
 *
 * AgroSense is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with AgroSense.  If not, see .
 */
package eu.agrosense.api.widget;

import javafx.beans.property.ObjectProperty;
import javafx.scene.Node;
import javafx.stage.Stage;

/**
 * A widget is reusable piece of gui.
 * In general a widget contains more functionality and/or is more complex then a normal form.
 * 
 *
 * @author Timon Veenstra 
 * @param  Component type
 */
public interface Widget {
    /**
     * Minimal width the widget needs to display its content
     * 
     * @return 
     */
    double getMinWidth();
    
    /**
     * Minimal height the widget needs to display its content
     * 
     * @return 
     */
    double getMinHeight();
    
    /**
     * Initialize the widget
     * @throws java.lang.Exception
     */
    void init() throws Exception;
    
    /**
     * Start things like animations in the Widget
     * @param context
     * @throws java.lang.Exception
     */
    void start(Stage context) throws Exception;
    
    /**
     * Stop things like animations in the Widget
     * @throws java.lang.Exception
     */
    void stop() throws Exception;
    
    /**
     * Get the widget as JavaFX node
     * 
     * @return 
     */
    N getAsNode();
    
    /**
     * get the icon for the widget
     * 
     * @return 
     */
    WidgetIcon getWidgetIcon();

    /**
     * set the widgets icon 
     * 
     * @param widgetIcon 
     */
    void setWidgetIcon(WidgetIcon widgetIcon);

    ObjectProperty widgetIconProperty();    
    
    WidgetState getWidgetState();
    
    
}