/*
 * Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code 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
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package com.javafx.experiments.dukepad.core;

import javafx.scene.Node;

/**
 * Any module that has settings that should be displayed in the SettingsApp module
 * should implement this interface and register it as a service. The SettingsApp will
 * discover it, and populate the settings app with the UI created by this interface.
 */
public interface Settings {
    /**
     * Used to differentiate an Application from system settings. The best way to do this
     * from an API perspective would be to use instance-of or some other means so that
     * apps cannot masquerade as system settings classes, but, hey.
     */
    public enum Type { SYSTEM, APPLICATION };
    public Type getType();

    /**
     * Allow modules to specify that they should be generally sorted higher or lower than other
     * settings. Basically we sort all things first by sort order (lower comes first), and then
     * by alphabet.
     *
     * @return The sort order. Don't return NaN, or I will not like you.
     */
    public int getSortOrder();
    public String getName();
    public Node createUI();
    public void disposeUI();
}
