view/classic/ClassicPrefs.java

/*
 *   JSampler - a java front-end for LinuxSampler
 *
 *   Copyright (C) 2005, 2006 Grigor Kirilov Iliev
 *
 *   This file is part of JSampler.
 *
 *   JSampler is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License version 2
 *   as published by the Free Software Foundation.
 *
 *   JSampler 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 JSampler; if not, write to the Free Software
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *   MA  02111-1307  USA
 */

package org.jsampler.view.classic;

import java.awt.Color;

import java.util.prefs.Preferences;


/**
 * This class represents the preferences of the JS Classic package.
 * @author Grigor Iliev
 */
public class ClassicPrefs {
        private final static String prefNode = "org.jsampler.view.classic";
        
        private final static String WINDOW_SIZE_AND_LOCATION = "Mainframe.sizeAndLocation";
        private final static String DEF_WINDOW_SIZE_AND_LOCATION = null;
        
        private final static String WINDOW_MAXIMIZED = "Mainframe.maximized";
        private final static boolean DEF_WINDOW_MAXIMIZED = false;
        
        private final static String SAVE_WINDOW_PROPERTIES = "Mainframe.saveProperties";
        private final static boolean DEF_SAVE_WINDOW_PROPERTIES = true;
        
        private final static String HSPLIT_DIVIDER_LOCATION = "HSplit.dividerLocation";
        private final static int DEF_HSPLIT_DIVIDER_LOCATION = 180;
        
        private final static String SAVE_LEFT_PANE_STATE = "LeftPane.saveState";
        private final static boolean DEF_SAVE_LEFT_PANE_STATE = true;
        
        private final static String LEFT_PANE_PAGE_IDX = "LeftPane.pageIndex";
        private final static int DEF_LEFT_PANE_PAGE_IDX = 0;
        
        private final static String SHOW_LS_CONSOLE_WHEN_RUN_SCRIPT = "showLSConsoleWhenRunScript";
        private final static boolean DEF_SHOW_LS_CONSOLE_WHEN_RUN_SCRIPT = true;
        
        private final static String SHOW_TOOLBAR = "Toolbar.visible";
        private final static boolean DEF_SHOW_TOOLBAR = true;
        
        private final static String SHOW_STATUSBAR = "Statusbar.visible";
        private final static boolean DEF_SHOW_STATUSBAR = true;
        
        private final static String SHOW_LEFT_PANE = "LeftPane.visible";
        private final static boolean DEF_SHOW_LEFT_PANE = true;
        
        private final static String RECENT_SCRIPTS = "recentScripts";
        private final static String DEF_RECENT_SCRIPTS = "";
        
        private final static String RECENT_SCRIPTS_SIZE = "recentScripts.maxNumber";
        private final static int DEF_RECENT_SCRIPTS_SIZE = 7;
        
        private final static String SHOW_LS_CONSOLE = "LSConsole.visible";
        private final static boolean DEF_SHOW_LS_CONSOLE = false;
        
        private final static String LS_CONSOLE_POPOUT = "LSConsole.popout";
        private final static boolean DEF_LS_CONSOLE_POPOUT = false;
        
        private final static String LS_CONSOLE_HISTORY = "LSConsole.history";
        private final static String DEF_LS_CONSOLE_HISTORY = "";
        
        private final static String LS_CONSOLE_HISTSIZE = "LSConsole.histsize";
        private final static int DEF_LS_CONSOLE_HISTSIZE = 1000;
        
        private final static String LS_CONSOLE_TEXT_COLOR = "LSConsole.textColor";
        private final static int DEF_LS_CONSOLE_TEXT_COLOR = 0x000000;
        
        private final static String LS_CONSOLE_BACKGROUND_COLOR = "LSConsole.backgroundColor";
        private final static int DEF_LS_CONSOLE_BACKGROUND_COLOR = 0xffffff;
        
        private final static String LS_CONSOLE_NOTIFY_COLOR = "LSConsole.notifyColor";
        private final static int DEF_LS_CONSOLE_NOTIFY_COLOR = 0xcccccc;
        
        private final static String LS_CONSOLE_WARNING_COLOR = "LSConsole.warningColor";
        private final static int DEF_LS_CONSOLE_WARNING_COLOR = 0x6699ff;
        
        private final static String LS_CONSOLE_ERROR_COLOR = "LSConsole.errorColor";
        private final static int DEF_LS_CONSOLE_ERROR_COLOR = 0xff0000;
        
        private final static String CHANNEL_BORDER_COLOR = "Channel.borderColor";
        private final static int DEF_CHANNEL_BORDER_COLOR = 0xb8cfe5;
        
        private final static String CUSTOM_CHANNEL_BORDER_COLOR = "Channel.customBorderColor";
        private final static boolean DEF_CUSTOM_CHANNEL_BORDER_COLOR = false;
        
        private final static String VSPLIT_DIVIDER_LOCATION = "VSplit.dividerLocation";
        private final static int DEF_VSPLIT_DIVIDER_LOCATION = 200;
        
        private final static String CURRENT_ORCHESTRA_IDX = "OrchestrasPage.currentOrchestraIndex";
        private final static int DEF_CURRENT_ORCHESTRA_IDX = 0;
        
        private static Preferences userPrefs = Preferences.userRoot().node(prefNode);
        
        public static Preferences
        user() { return userPrefs; }
        
        /**
         * Gets a string representation of the main window's size and location.
         * The string representation is a comma-separated list
         * of x and y coordinates, and width and height of the window.
         * @return A string representation of the main window's size and location,
         * or <code>null</code> if the value is not set.
         */
        public static String
        getWindowSizeAndLocation() {
                return user().get(WINDOW_SIZE_AND_LOCATION, DEF_WINDOW_SIZE_AND_LOCATION);
        }
        
        /**
         * Sets the main window's size and location.
         * Use <code>null</code> to remove the current value.
         * @param s A string representation of the main window's size and location.
         */
        public static void
        setWindowSizeAndLocation(String s) {
                if(s == null) {
                        user().remove(WINDOW_SIZE_AND_LOCATION);
                        return;
                }
                
                user().put(WINDOW_SIZE_AND_LOCATION, s);
        }
        
        /**
         * Determines whether the main window should be maximized.
         * @return <code>true</code> if the main window should be maximized,
         * <code>false</code> otherwise.
         */
        public static boolean
        getWindowMaximized() {
                return user().getBoolean(WINDOW_MAXIMIZED, DEF_WINDOW_MAXIMIZED);
        }
        
        /**
         * Sets whether the main window should be maximized.
         * @param b If <code>true</code> the main window should be maximized.
         */
        public static void
        setWindowMaximized(boolean b) {
                if(b == getWindowMaximized()) return;
                user().putBoolean(WINDOW_MAXIMIZED, b);
        }
        
        /**
         * Gets the divider location of the horizontal split pane.
         * @return The divider location of the horizontal split pane.
         */
        public static int
        getHSplitDividerLocation() {
                return user().getInt(HSPLIT_DIVIDER_LOCATION, DEF_HSPLIT_DIVIDER_LOCATION);
        }
        
        /**
         * Sets the divider location of the horizontal split pane.
         * @param i The new divider location of the horizontal split pane.
         */
        public static void
        setHSplitDividerLocation(int i) {
                if(i == getHSplitDividerLocation()) return;
                user().putInt(HSPLIT_DIVIDER_LOCATION, i);
        }
        
        /**
         * Determines whether the window properties (like size and location) should be saved.
         * @return <code>true</code> if the window properties should be saved,
         * <code>false</code> otherwise.
         */
        public static boolean
        getSaveWindowProperties() {
                return user().getBoolean(SAVE_WINDOW_PROPERTIES, DEF_SAVE_WINDOW_PROPERTIES);
        }
        
        /**
         * Sets whether the window properties (like size and location) should be saved.
         * @param b If <code>true</code> the window properties will be saved.
         */
        public static void
        setSaveWindowProperties(boolean b) {
                if(b == getSaveWindowProperties()) return;
                user().putBoolean(SAVE_WINDOW_PROPERTIES, b);
        }
        
        /**
         * Determines whether the Left Pane state should be saved.
         * @return <code>true</code> if the Left Pane state should be saved,
         * <code>false</code> otherwise.
         */
        public static boolean
        getSaveLeftPaneState() {
                return user().getBoolean(SAVE_LEFT_PANE_STATE, DEF_SAVE_LEFT_PANE_STATE);
        }
        
        /**
         * Sets whether the Left Pane state should be saved.
         * @param b If <code>true</code> the Left Pane state will be saved.
         */
        public static void
        setSaveLeftPaneState(boolean b) {
                if(b == getSaveLeftPaneState()) return;
                user().putBoolean(SAVE_LEFT_PANE_STATE, b);
        }
        
        /**
         * Gets the index of the page to be shown in the Left Pane.
         * @return The index of the page to be shown in the Left Pane.
         */
        public static int
        getLeftPanePageIndex() {
                return user().getInt(LEFT_PANE_PAGE_IDX, DEF_LEFT_PANE_PAGE_IDX);
        }
        
        /**
         * Sets the maximum number of recent scripts to be kept.
         * @param i Determines the maximum number of recent scripts to be kept.
         */
        public static void
        setLeftPanePageIndex(int i) {
                if(i == getLeftPanePageIndex()) return;
                user().putInt(LEFT_PANE_PAGE_IDX, i);
        }
        
        /**
         * Determines whether to show the LS Console when script is run.
         * @return <code>true</code> if the LS Console should be shown when script is run,
         * <code>false</code> otherwise.
         */
        public static boolean
        getShowLSConsoleWhenRunScript() {
                return user().getBoolean (
                        SHOW_LS_CONSOLE_WHEN_RUN_SCRIPT, DEF_SHOW_LS_CONSOLE_WHEN_RUN_SCRIPT
                );
        }
        
        /**
         * Sets whether to show the LS Console when script is run.
         * @param b Specify <code>true</code> to show LS Console when script is run,
         * <code>false</code> otherwise.
         */
        public static void
        setShowLSConsoleWhenRunScript(boolean b) {
                if(b == getShowLSConsoleWhenRunScript()) return;
                user().putBoolean(SHOW_LS_CONSOLE_WHEN_RUN_SCRIPT, b);
        }
        
        /**
         * Determines whether the toolbar should be visible.
         * @return <code>true</code> if the toolbar should be visible,
         * <code>false</code> otherwise.
         */
        public static boolean
        shouldShowToolbar() { return user().getBoolean(SHOW_TOOLBAR, DEF_SHOW_TOOLBAR); }
        
        /**
         * Sets whether the toolbar should be visible.
         * @param b If <code>true</code> the toolbar will be visible at startup.
         */
        public static void
        setShowToolbar(boolean b) {
                if(b == shouldShowToolbar()) return;
                user().putBoolean(SHOW_TOOLBAR, b);
        }
        
        /**
         * Determines whether the statusbar should be visible.
         * @return <code>true</code> if the statusbar should be visible,
         * <code>false</code> otherwise.
         */
        public static boolean
        shouldShowStatusbar() { return user().getBoolean(SHOW_STATUSBAR, DEF_SHOW_STATUSBAR); }
        
        /**
         * Sets whether the statusbar should be visible.
         * @param b If <code>true</code> the statusbar will be visible at startup.
         */
        public static void
        setShowStatusbar(boolean b) {
                if(b == shouldShowStatusbar()) return;
                user().putBoolean(SHOW_STATUSBAR, b);
        }
        
        /**
         * Gets the recent script list.
         * @return The recent script list.
         */
        public static String
        getRecentScripts() {
                return user().get(RECENT_SCRIPTS, DEF_RECENT_SCRIPTS);
        }
        
        /**
         * Sets the recent script list.
         * @param s The recent script list.
         */
        public static void
        setRecentScripts(String s) {
                if(s == null) {
                        user().remove(RECENT_SCRIPTS);
                        return;
                }
                
                user().put(RECENT_SCRIPTS, s);
        }
        
        /**
         * Determines the maximum number of recent scripts to be kept.
         * @return The maximum number of recent scripts to be kept.
         */
        public static int
        getRecentScriptsSize() {
                return user().getInt(RECENT_SCRIPTS_SIZE, DEF_RECENT_SCRIPTS_SIZE);
        }
        
        /**
         * Sets the maximum number of recent scripts to be kept.
         * @param i Determines the maximum number of recent scripts to be kept.
         */
        public static void
        setRecentScriptstSize(int i) {
                if(i == getRecentScriptsSize()) return;
                user().putInt(RECENT_SCRIPTS_SIZE, i);
        }
        
        /**
         * Determines whether the LS Console should be visible.
         * @return <code>true</code> if the LS Console should be visible,
         * <code>false</code> otherwise.
         */
        public static boolean
        shouldShowLSConsole() { return user().getBoolean(SHOW_LS_CONSOLE, DEF_SHOW_LS_CONSOLE); }
        
        /**
         * Sets whether the LS Console should be visible.
         * @param b If <code>true</code> the LS Console will be visible at startup.
         */
        public static void
        setShowLSConsole(boolean b) {
                if(b == shouldShowLSConsole()) return;
                user().putBoolean(SHOW_LS_CONSOLE, b);
        }
        
        /**
         * Determines whether the LS Console should be shown in a new window or
         * docked in the main frame.
         * @return <code>true</code> if the LS Console should be shown in a new window,
         * <code>false</code> if the LS Console should be docked in the main frame.
         */
        public static boolean
        isLSConsolePopOut() { return user().getBoolean(LS_CONSOLE_POPOUT, DEF_LS_CONSOLE_POPOUT); }
        
        /**
         * Sets whether the LS Console should be shown in a new window or
         * docked in the main frame.
         * @param b code>true</code> means that the LS Console will be shown in a new window;
         * <code>false</code> means that the LS Console will be docked in the main frame.
         */
        public static void
        setLSConsolePopOut(boolean b) {
                if(b == isLSConsolePopOut()) return;
                user().putBoolean(LS_CONSOLE_POPOUT, b);
        }
        
        /**
         * Gets the LS Console's command history.
         * @return The LS Console's command history.
         */
        public static String
        getLSConsoleHistory() {
                return user().get(LS_CONSOLE_HISTORY, DEF_LS_CONSOLE_HISTORY);
        }
        
        /**
         * Sets the LS Console's command history.
         * @param s The LS Console's command history.
         */
        public static void
        setLSConsoleHistory(String s) {
                if(s == null) {
                        user().remove(LS_CONSOLE_HISTORY);
                        return;
                }
                
                user().put(LS_CONSOLE_HISTORY, s);
        }
        
        /**
         * Gets the LS Console's command history size.
         * @return The maximum number of lines to be kept in the command history.
         */
        public static int
        getLSConsoleHistSize() {
                return user().getInt(LS_CONSOLE_HISTSIZE, DEF_LS_CONSOLE_HISTSIZE);
        }
        
        /**
         * Sets the LS Console's command history size.
         * @param i The maximum number of lines to be kept in the command history.
         */
        public static void
        setLSConsoleHistSize(int i) {
                if(i == getLSConsoleHistSize()) return;
                user().putInt(LS_CONSOLE_HISTSIZE, i);
        }
        
        /**
         * Gets the text color of the LS Console.
         * @return The text color of the LS Console.
         */
        public static Color
        getLSConsoleTextColor() {
                int c = user().getInt(LS_CONSOLE_TEXT_COLOR, DEF_LS_CONSOLE_TEXT_COLOR);
                return new Color(c);
        }
        
        /**
         * Sets the text color of the LS Console.
         * Use <code>null</code> to remove the current value.
         * @param color The text color of the LS Console.
         */
        public static void
        setLSConsoleTextColor(Color c) {
                if(c == null) {
                        user().remove(LS_CONSOLE_TEXT_COLOR);
                        return;
                }
                
                if(c.getRGB() == getLSConsoleTextColor().getRGB()) return;
                
                user().putInt(LS_CONSOLE_TEXT_COLOR, c.getRGB());
        }
        
        /**
         * Gets the background color of the LS Console.
         * @return The background color of the LS Console.
         */
        public static Color
        getLSConsoleBackgroundColor() {
                int c = user().getInt(LS_CONSOLE_BACKGROUND_COLOR, DEF_LS_CONSOLE_BACKGROUND_COLOR);
                return new Color(c);
        }
        
        /**
         * Sets the background color of the LS Console.
         * Use <code>null</code> to remove the current value.
         * @param color The background color of the LS Console.
         */
        public static void
        setLSConsoleBackgroundColor(Color c) {
                if(c == null) {
                        user().remove(LS_CONSOLE_BACKGROUND_COLOR);
                        return;
                }
                
                if(c.getRGB() == getLSConsoleBackgroundColor().getRGB()) return;
                
                user().putInt(LS_CONSOLE_BACKGROUND_COLOR, c.getRGB());
        }
        
        /**
         * Gets the notification messages' color.
         * @return The notification messages' color.
         */
        public static Color
        getLSConsoleNotifyColor() {
                int c = user().getInt(LS_CONSOLE_NOTIFY_COLOR, DEF_LS_CONSOLE_NOTIFY_COLOR);
                return new Color(c);
        }
        
        /**
         * Sets the notification messages' color.
         * Use <code>null</code> to remove the current value.
         * @param color The notification messages' color.
         */
        public static void
        setLSConsoleNotifyColor(Color c) {
                if(c == null) {
                        user().remove(LS_CONSOLE_NOTIFY_COLOR);
                        return;
                }
                
                if(c.getRGB() == getLSConsoleNotifyColor().getRGB()) return;
                
                user().putInt(LS_CONSOLE_NOTIFY_COLOR, c.getRGB());
        }
        
        /**
         * Gets the warning messages' color.
         * @return The warning messages' color.
         */
        public static Color
        getLSConsoleWarningColor() {
                int c = user().getInt(LS_CONSOLE_WARNING_COLOR, DEF_LS_CONSOLE_WARNING_COLOR);
                return new Color(c);
        }
        
        /**
         * Sets the warning messages' color.
         * Use <code>null</code> to remove the current value.
         * @param color The warning messages' color.
         */
        public static void
        setLSConsoleWarningColor(Color c) {
                if(c == null) {
                        user().remove(LS_CONSOLE_WARNING_COLOR);
                        return;
                }
                
                if(c.getRGB() == getLSConsoleWarningColor().getRGB()) return;
                
                user().putInt(LS_CONSOLE_WARNING_COLOR, c.getRGB());
        }
        
        /**
         * Gets the error messages' color.
         * @return The error messages' color.
         */
        public static Color
        getLSConsoleErrorColor() {
                int c = user().getInt(LS_CONSOLE_ERROR_COLOR, DEF_LS_CONSOLE_ERROR_COLOR);
                return new Color(c);
        }
        
        /**
         * Sets the error messages' color.
         * Use <code>null</code> to remove the current value.
         * @param color The error messages' color.
         */
        public static void
        setLSConsoleErrorColor(Color c) {
                if(c == null) {
                        user().remove(LS_CONSOLE_ERROR_COLOR);
                        return;
                }
                
                if(c.getRGB() == getLSConsoleErrorColor().getRGB()) return;
                
                user().putInt(LS_CONSOLE_ERROR_COLOR, c.getRGB());
        }
        
        /**
         * Determines whether the left pane should be visible.
         * @return <code>true</code> if the left pane should be visible,
         * <code>false</code> otherwise.
         */
        public static boolean
        shouldShowLeftPane() { return user().getBoolean(SHOW_LEFT_PANE, DEF_SHOW_LEFT_PANE); }
        
        /**
         * Sets whether the left pane should be visible.
         * @param b If <code>true</code> the left pane will be visible at startup.
         */
        public static void
        setShowLeftPane(boolean b) {
                if(b == shouldShowLeftPane()) return;
                user().putBoolean(SHOW_LEFT_PANE, b);
        }
        
        /**
         * Gets the default border color that is used for the selected channels.
         * @return The default border color that is used for the selected channels.
         */
        public static Color
        getDefaultChannelBorderColor() { return new Color(DEF_CHANNEL_BORDER_COLOR); }
        
        /**
         * Gets the custom border color to be used for the selected channels.
         * @return The custom border color to be used for the selected channels.
         */
        public static Color
        getChannelBorderColor() {
                int c = user().getInt(CHANNEL_BORDER_COLOR, DEF_CHANNEL_BORDER_COLOR);
                return new Color(c);
        }
        
        /**
         * Sets the border color to be used for the selected channels.
         * Use <code>null</code> to remove the current value.
         * @param color The border color to be used for the selected channels.
         */
        public static void
        setChannelBorderColor(Color c) {
                if(c == null) {
                        user().remove(CHANNEL_BORDER_COLOR);
                        return;
                }
                
                if(c.getRGB() == getChannelBorderColor().getRGB()) return;
                
                user().putInt(CHANNEL_BORDER_COLOR, c.getRGB());
        }
        
        /**
         * Determines whether to use a custom border color for the selected channels.
         * @return <code>true</code> if custom border color must be used
         * for the selected channels, <code>false</code> otherwise.
         */
        public static boolean
        getCustomChannelBorderColor() {
                return user().getBoolean (
                        CUSTOM_CHANNEL_BORDER_COLOR, DEF_CUSTOM_CHANNEL_BORDER_COLOR
                );
        }
        
        /**
         * Sets whether to use a custom border color for the selected channels.
         * @param b specify <code>true</code> to use a custom border color
         * for the selected channels, <code>false</code> otherwise.
         */
        public static void
        setCustomChannelBorderColor(boolean b) {
                if(b == getCustomChannelBorderColor()) return;
                user().putBoolean(CUSTOM_CHANNEL_BORDER_COLOR, b);
        }
        
        /**
         * Gets the divider location of the vertical split pane.
         * @return The divider location of the vertical split pane.
         */
        public static int
        getVSplitDividerLocation() {
                return user().getInt(VSPLIT_DIVIDER_LOCATION, DEF_VSPLIT_DIVIDER_LOCATION);
        }
        
        /**
         * Sets the divider location of the vertical split pane.
         * @param i The new divider location of the vertical split pane.
         */
        public static void
        setVSplitDividerLocation(int i) {
                if(i == getVSplitDividerLocation()) return;
                user().putInt(VSPLIT_DIVIDER_LOCATION, i);
        }
        
        /**
         * Gets the current orchestra index of the last session.
         * @return The current orchestra index of the last session.
         */
        public static int
        getCurrentOrchestraIndex() {
                return user().getInt(CURRENT_ORCHESTRA_IDX, DEF_CURRENT_ORCHESTRA_IDX);
        }
        
        /**
         * Sets the current orchestra index.
         * @param i The orchestra index to be set as current.
         */
        public static void
        setCurrentOrchestraIndex(int i) {
                if(i == getCurrentOrchestraIndex()) return;
                user().putInt(CURRENT_ORCHESTRA_IDX, i);
        }
}