Application: gvSIG desktop » Library: org.gvsig.tools

package org.gvsig.propertypage;

import org.gvsig.tools.swing.api.Component;

import org.gvsig.tools.util.Invocable;

public interface PropertiesPage extends Component {

    public interface SetPageEnabledEvent {

        public static int ID = 0xCAFE0001;

        public static String ACTION_COMMAND = "SetPageEnabled";

        public Invocable getFilter();

        public boolean isEnabled();

    }

    public void setData(Object data);

    /**

     * Title of the properties page

     * 

     * @return the title.

     */    

    public String getTitle();

    /**

     * The priority of this properties page.

     * When more high is the priority more to the left are set properties page.

     * 

     * @return the priority of the properties page

     */

    public int getPriority();

    /**

     * Called when the button accept is presed by the user.

     * If return false the panel is not hidden and do not call whenAccept of

     * other properties pages.

     * 

     * @return false to cancel the user action.

     */

    public boolean whenAccept();

    /**

     * Called when the button apply is presed by the user.

     * If return false the panel do not call whenApply of

     * other properties pages.

     * 

     * @return false to cancel the user action.

     */

    public boolean whenApply();

    /**

     * Called when the button accept is presed by the user.

     * If return false the panel is not hidden and do not call whenCancel of

     * other properties pages.

     * 

     * @return false to cancel the user action.

     */

    public boolean whenCancel();

}