Save and Load GUI settings

[Worthy 1,232]

Save and Load GUI Settings Tutorial

by Worthy

 
In this tutorial
We will be using java.util Propteries class to save and load settings from your GUI (or anything else that is applicable)

________
Adding the proper variables for preparation.
In your Main class add the location to save the GUI settings

 

public static final File PATH  = new File(Util.getWorkingDirectory().getAbsolutePath(), "scriptname_" + "settings.ini");

 

 

In your GUI class we must create the Save and Load settings methods

 

    private Properties prop;
 
    public GUIExample() {
        this.prop = new Properties();
        initComponents();
    }

	private void saveSettings() {
        try {
            prop.clear();    //clear settings to avoid issues re-using this method (optional)
            prop.put("test2_checkBox", String.valueOf(test2_checkBox.isSelected()));    //example of JCheckBox
            prop.put("test1_comboBox", String.valueOf(test1_comboBox.getSelectedItem()));    //example of JComboBox
            prop.put("test1_spinner", String.valueOf(test1_spinner.getValue()));    //example of JSpinner
            prop.put("test1_textField", test1_textField.getText());    //example of JSpinner
            prop.store(new FileOutputStream(GUISettings.PATH), "GUI Settings");
        } catch (Exception e1) {
            System.out.print("Unable to save settings");
            e1.printStackTrace();
        }
    }

    public void loadSettings() {   //we will call this externally
        try {
            if (!GUISettings.PATH.exists()) {         //make sure file exists
                GUISettings.PATH.createNewFile();      //or make a new one
            }
            prop.load(new FileInputStream(GUISettings.PATH));
            String[] buttonNames = {"test2_checkBox"};   //helpful if all the names match
            JCheckBox[] boxes = {test2_checkBox};
            for (int i = 0; i < buttonNames.length; i++) {
                String value = prop.getProperty(buttonNames[i]);
                boxes[i].setSelected(Boolean.valueOf(value));   //load JCheckBoxes            //note you must convert the String to a boolean
            }
            String[] comboxNames = {"test1_comboBox"};
            JComboBox[] combos = {test1_comboBox};
            for (int i = 0; i < comboxNames.length; i++) {
                String value = prop.getProperty(comboxNames[i]);
                if (value != null) {
                    combos[i].setSelectedItem(value);         //load JComboBoxes                //note no conversion to an Object is necessary because a String is already an Object
                }
            }
            String[] spinnerNames = {"test1_spinner"};
            JSpinner[] spinners = {test1_spinner};
            for (int i = 0; i < spinnerNames.length; i++) {
                String value = prop.getProperty(spinnerNames[i]);
                if (value != null) {
                    spinners[i].setValue(Integer.parseInt(value));   //load JSpinners                //must take ints
                }
            }
            String[] textFieldNames = {"test1_textField"};
            JTextField[] textFields = {test1_textField};
            for (int i = 0; i < textFieldNames.length; i++) {
                String value = prop.getProperty(textFieldNames[i]);
                if (value != null) {
                    textFields[i].setText(value);   //load JTextFields
                }
            }
        } catch (Exception e2) {
            System.out.print("Unable to load settings");
            e2.printStackTrace();
        }
    }

 

 

Implementing the methods
On the "Start" button, we will call saveSettings();
On the script initiation we will call the loadSettings(); (after the GUI has been loaded)
 
-->Alternatively you can just create seperate save and load buttons on the GUI.


Tying everything together:
The first thing the script will do is declare the File Path, and initiate the Preferences file.
When the GUI loads, the script will then call loadSettings(), loading the settings (if any).
If no settings are saved, it well then create a new file in the path.
Right before the GUI is disposed it will save all the settings the user has applied in TRiBot's storage directory. (You can print out the location if you don't know where that is for your OS).

_________
Complete Example script:
GUISettings.java (Main class)

 

package scripts;

import org.tribot.api.General;
import org.tribot.script.Script;
import org.tribot.script.ScriptManifest;
import org.tribot.util.Util;

import javax.swing.*;
import java.io.File;

@ScriptManifest(authors = {"Worthy"}, category = "Tools", name = "GUI Settings Example", description="v1")
public class GUISettings extends Script {

    public static final File PATH  = new File(Util.getWorkingDirectory().getAbsolutePath(), "scriptname_" + "settings.ini");
    private GUIExample guiExample;

    @Override
    public void run() {
        //this code initializes and displays your GUI
        guiExample = new GUIExample();
        try {
            SwingUtilities.invokeLater(() -> {
                guiExample.loadSettings();
                guiExample.setVisible(true);
            });
        } catch (Throwable ignore) {
            System.out.println("Failed to load error Popup GUI.");
        }

        //your script logic here:
        while (!guiExample.isDoneFillingOutGUI()) {
            General.sleep(500);
        }
    }
}

 

GUIExample.java (GUI class)

 

package scripts;

import javax.swing.*;
import java.awt.*;
import java.awt.event.ActionEvent;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.util.Properties;

/**
 * @author Worthy
 */
public class GUIExample extends JFrame {

    private Properties prop;
    private boolean waitForGUI = true;

    public GUIExample() {
        this.prop = new Properties();
        initComponents();
    }

    public boolean isDoneFillingOutGUI() {
        return !waitForGUI;
    }

    private void button_startActionPerformed(ActionEvent e) {
        // do script code variable assignment and other stuff here

        saveSettings();
        waitForGUI = false; //can use this to notify script when user is done selecting GUI options
        this.dispose();
    }

    private void saveSettings() {
        try {
            prop.clear();    //clear settings to avoid issues re-using this method (optional)
            prop.put("test2_checkBox", String.valueOf(test2_checkBox.isSelected()));    //example of JCheckBox
            prop.put("test1_comboBox", String.valueOf(test1_comboBox.getSelectedItem()));    //example of JComboBox
            prop.put("test1_spinner", String.valueOf(test1_spinner.getValue()));    //example of JSpinner
            prop.put("test1_textField", test1_textField.getText());    //example of JSpinner
            prop.store(new FileOutputStream(GUISettings.PATH), "GUI Settings");
        } catch (Exception e1) {
            System.out.print("Unable to save settings");
            e1.printStackTrace();
        }
    }

    public void loadSettings() {   //we will call this externally
        try {
            if (!GUISettings.PATH.exists()) {         //make sure file exists
                GUISettings.PATH.createNewFile();      //or make a new one
            }
            prop.load(new FileInputStream(GUISettings.PATH));
            String[] buttonNames = {"test2_checkBox"};   //helpful if all the names match
            JCheckBox[] boxes = {test2_checkBox};
            for (int i = 0; i < buttonNames.length; i++) {
                String value = prop.getProperty(buttonNames[i]);
                boxes[i].setSelected(Boolean.valueOf(value));   //load JCheckBoxes            //note you must convert the String to a boolean
            }
            String[] comboxNames = {"test1_comboBox"};
            JComboBox[] combos = {test1_comboBox};
            for (int i = 0; i < comboxNames.length; i++) {
                String value = prop.getProperty(comboxNames[i]);
                if (value != null) {
                    combos[i].setSelectedItem(value);         //load JComboBoxes                //note no conversion to an Object is necessary because a String is already an Object
                }
            }
            String[] spinnerNames = {"test1_spinner"};
            JSpinner[] spinners = {test1_spinner};
            for (int i = 0; i < spinnerNames.length; i++) {
                String value = prop.getProperty(spinnerNames[i]);
                if (value != null) {
                    spinners[i].setValue(Integer.parseInt(value));   //load JSpinners                //must take ints
                }
            }
            String[] textFieldNames = {"test1_textField"};
            JTextField[] textFields = {test1_textField};
            for (int i = 0; i < textFieldNames.length; i++) {
                String value = prop.getProperty(textFieldNames[i]);
                if (value != null) {
                    textFields[i].setText(value);   //load JTextFields
                }
            }
        } catch (Exception e2) {
            System.out.print("Unable to load settings");
            e2.printStackTrace();
        }
    }

    //this GUI has been generated using a GUI builder
    private void initComponents() {
        button_start = new JButton();
        test2_checkBox = new JCheckBox();
        test1_comboBox = new JComboBox<>();
        label1 = new JLabel();
        test1_spinner = new JSpinner();
        label2 = new JLabel();
        label3 = new JLabel();
        test1_textField = new JTextField();
        separator1 = new JSeparator();

        //======== this ========
        setTitle("Example GUI");
        setAlwaysOnTop(true);
        Container contentPane = getContentPane();
        contentPane.setLayout(null);

        //---- button_start ----
        button_start.setText("Start (Dispose and Save)");
        button_start.addActionListener(e -> button_startActionPerformed(e));
        contentPane.add(button_start);
        button_start.setBounds(85, 155, 190, 23);

        //---- test2_checkBox ----
        test2_checkBox.setText("check");
        contentPane.add(test2_checkBox);
        test2_checkBox.setBounds(15, 35, 60, 23);

        //---- test1_comboBox ----
        test1_comboBox.setModel(new DefaultComboBoxModel<>(new String[] {
            "test1",
            "test2",
            "test3",
            "test4",
            "pizza"
        }));
        contentPane.add(test1_comboBox);
        test1_comboBox.setBounds(185, 70, 130, test1_comboBox.getPreferredSize().height);

        //---- label1 ----
        label1.setText("Select any Option!");
        contentPane.add(label1);
        label1.setBounds(15, 70, 125, 20);
        contentPane.add(test1_spinner);
        test1_spinner.setBounds(185, 95, 130, test1_spinner.getPreferredSize().height);

        //---- label2 ----
        label2.setText("Input any Value!");
        contentPane.add(label2);
        label2.setBounds(15, 95, 95, 20);

        //---- label3 ----
        label3.setText("Write anything!");
        contentPane.add(label3);
        label3.setBounds(15, 120, 95, 20);
        contentPane.add(test1_textField);
        test1_textField.setBounds(185, 115, 130, test1_textField.getPreferredSize().height);
        contentPane.add(separator1);
        separator1.setBounds(15, 60, separator1.getPreferredSize().width, 2);

        { // compute preferred size
            Dimension preferredSize = new Dimension();
            for(int i = 0; i < contentPane.getComponentCount(); i++) {
                Rectangle bounds = contentPane.getComponent(i).getBounds();
                preferredSize.width = Math.max(bounds.x + bounds.width, preferredSize.width);
                preferredSize.height = Math.max(bounds.y + bounds.height, preferredSize.height);
            }
            Insets insets = contentPane.getInsets();
            preferredSize.width += insets.right;
            preferredSize.height += insets.bottom;
            contentPane.setMinimumSize(preferredSize);
            contentPane.setPreferredSize(preferredSize);
        }
        setSize(360, 230);
        setLocationRelativeTo(null);
    }

    private JButton button_start;
    private JCheckBox test2_checkBox;
    private JComboBox<String> test1_comboBox;
    private JLabel label1;
    private JSpinner test1_spinner;
    private JLabel label2;
    private JLabel label3;
    private JTextField test1_textField;
    private JSeparator separator1;
}

 

 

 

Regards,
Worthy

 

 

Edited June 26, 2018 by Worthy

[Starfox 783]

Properties props = new Properties();File file = new File(Util.getWorkingDirectory().getAbsolutePath() + "name.ini");props.load(new FileReader(file));props.load(new FileWriter(file), "");

Use props like you would a HashMap of type <String, String>, that is all you need.

[Worthy 1,232]

Properties props = new Properties();File file = new File(Util.getWorkingDirectory().getAbsolutePath() + "name.ini");props.load(new FileReader(file));props.load(new FileWriter(file), "");

Use props like you would a HashMap of type <String, String>, that is all you need.

 

I don't see why that is necessary when you can use a FileInputStream.

And yeah you do use it like HashMap with the put and getProperty settings

Edited January 1, 2014 by Worthy

[Starfox 783]

I don't see why that is necessary when you can use a FileInputStream.

And yeah you do use it like HashMap with the put and getProperty settings

You have extra code in there. FileWriter will just write to that file, and create a new one if one does not exist yet. You also don't need to use clear.

[thunderkill 3]

Amazing job once again worthy!

[Pixsis 0]

Please help I have dinner bell and get the guide to load preset and it says calling the servant the servant comes and nothing happens

[Worthy 1,232]

Please help I have dinner bell and get the guide to load preset and it says calling the servant the servant comes and nothing happens

I got your PM, although you posted this on the wrong thread.

[OjDidntDoIt 0]

i purchased script and can't seen to get it to work can't save a preset for it to start 

 

[Guest]

i purchased script can get it to work will only list what to do in text no green click here stuff or ground positioning

[YoHoJo 2,037]

On 10/19/2016 at 10:25 PM, OjDidntDoIt said:

i purchased script and can't seen to get it to work can't save a preset for it to start 

 

 

1 hour ago, dazarius said:

i purchased script can get it to work will only list what to do in text no green click here stuff or ground positioning

This is a programming tutorial on how to save GUI settings.
If you need help with a specific script, post your issue on the script's thread for assistance.

[Shockplug 3]

Very nice tutorial! If you want to write an object to file using props does it have to be a string? 

[Worthy 1,232]

53 minutes ago, Shockplug said:

Very nice tutorial! If you want to write an object to file using props does it have to be a string? 

If you would like to store a java object then I recommend looking up Serialization.

If you want to store something using properties it does not have to be a string, just any nonnull object will do. Properties are just a key-value pair mapping between objects.

[Shockplug 3]

On 3/7/2017 at 8:34 PM, Worthy said:

If you would like to store a java object then I recommend looking up Serialization.

If you want to store something using properties it does not have to be a string, just any nonnull object will do. Properties are just a key-value pair mapping between objects.

Yea, I was thinking I would just use serialization, thanks!

[Naton 806]

Thank you for this 

[Jerminater 27]

@Worthy Any chance you could update the link for the example script at the end of the post?

Thanks!

 

[Worthy 1,232]

2 hours ago, Jerminater said:

@Worthy Any chance you could update the link for the example script at the end of the post?

Thanks!

 

Updated

[AliveInMe 9]

Thanks for this tutorial  I've been using the code for a while

[Darth Bane 0]

Thanks for this, will probably use this in my next script

[Guest]

hey how do i set it up for oak ladders im having a hard time with it

[YoHoJo 2,037]

56 minutes ago, basedgod902 said:

hey how do i set it up for oak ladders im having a hard time with it

I think you posted on the wrong thread.