Difference between revisions of "How to define play-in-able Swing GUI application"

From WeizmannWiki
Jump to: navigation, search
(Binding expression for dynamic instances)
Line 4: Line 4:
  
 
===Write your Swing code===
 
===Write your Swing code===
====Using WindowBuilder plugin====
+
====Using the WindowBuilder plugin====
One possible option for creating the Swing GUI application is using the WindowBuilder plugin.
+
One possible option for creating the Swing GUI application is to use the WindowBuilder plugin.
Follow the instructions below:
+
Follow these instructions:
 
# Install the WindowBuilder plugin from: [http://www.eclipse.org/windowbuilder/]
 
# Install the WindowBuilder plugin from: [http://www.eclipse.org/windowbuilder/]
# Use the System Model view to define the classes and object that participate in your application.
+
# Use the System Model view to define the classes and objects that participate in your application.
## Classes that has a gui representation (that are actually part of the GUI) should extend one of the Swing available classes (JButton, JTextField, etc...).
+
## Classes that have a GUI representation should extend one of the Swing available classes (JButton, JTextField, etc...).
## Classes that has a gui representation should be marked as such (check the 'GUI' radio button).
+
## Classes that have a GUI representation should be marked as such (check the 'GUI' radio button, by clicking the corresponding radio button when creating a class).
 
# Create the application window using the WindowBuilder plugin.
 
# Create the application window using the WindowBuilder plugin.
## Use the "Choose Component" option to choose the classes defined using the System Model a the application GUI components.
+
## Use the "Choose Component" option to choose the classes defined using the System Model.
##In the application window->design tab, write under the constructor->name field the name of the object as was given to it in the System Model (since the System Model object and the GUI component are the exact same object in the application).
+
## In the application window->design tab, under the constructor->name field, write the name of the object as was given to it in the System Model (since the System Model object and the GUI component are the exact same object in the application).
  
 
====Manually writing Java Swing code====
 
====Manually writing Java Swing code====
#One can choose to write the GUI in pure Java Swing code.
+
#You can choose to write the GUI in pure Java Swing code.
 
#Once the code is complete, use the '''import''' button from the System Model view to create a System Model from the Java Code.
 
#Once the code is complete, use the '''import''' button from the System Model view to create a System Model from the Java Code.
  
===Make your GUI Playinable===
+
===Make your GUI play-in-able===
Right click your LSC project-->Properties-->click "Play-In" section under "PlayGo"-->check the "Make GUI playinable" check box.
+
Right-click your LSC project-->Properties-->PlayGo-->Play-In. Check the "Make GUI Play-in-able" check box:
  
This action will add the '''il.ac.wis.cs.playgo.guitoolkit''' to the aspect path.
+
[[Image:play-in-able.jpg]]
  
If the run configuration argument '''Ddev''' is true, the guitoolkit project will be added, otherwise the guitoolkit jar is added.
+
===Right-click menu===
 
+
All public methods that are defined in your component's class will appear in the component's right-click menu during play-in.
===Right click menu===
+
All public methods which are defined in your component's class will appear in the component's right click menu in play-in.
+
 
If you wish to omit one of the methods, do the following:
 
If you wish to omit one of the methods, do the following:
  
Line 34: Line 32:
 
2. Add the '''@NonPlayInable''' annotation before the method you'd like to omit
 
2. Add the '''@NonPlayInable''' annotation before the method you'd like to omit
  
[[Instructions for java-based GUI (e.g. SWT, Swing) | More info...]]
+
===Supported Swing components and component's default action===
  
===Supported Swing components & component's default action===
+
All Swing components that are made play-in-able once clicking the "Make GUI play-in-able" check box, are defined in the '''swingComponents''' hash table under '''il.ac.wis.cs.automateplayin.GUIComponents.java''' in the '''guitoolkit''' project.
 
+
All swing components which are made play-in-able once clicking the "Make GUI play-in-able" check box, are defined in '''swingComponents''' hash table under il.ac.wis.cs.automateplayin.'''GUIComponents.java''' in the '''guitoolkit''' project.
+
 
The components are added along with their event listeners and their default action.
 
The components are added along with their event listeners and their default action.
 
+
For example, JButton is added to the hash table as follows:<br>
e.g JButton is added to the hash table as follows:
+
 
'''swingComponents.put(Constants.JBUTTON, new String[]{Constants.ACTION_LISTENER,Constants.CLICK_ACTION});'''
 
'''swingComponents.put(Constants.JBUTTON, new String[]{Constants.ACTION_LISTENER,Constants.CLICK_ACTION});'''
  
Components which have no default action are added with no listener and default action, e.g JLable is added as follows:
+
Components that have no default action are added with no listener and default action; e.g., JLable is added as follows:
 
'''swingComponents.put(Constants.JLABEL, new String[]{"",""});'''
 
'''swingComponents.put(Constants.JLABEL, new String[]{"",""});'''
  
For now, the supported event listeners are Action Listener and Change Listener.
+
Currently, the supported event listeners are Action Listener and Change Listener.
  
=== Binding expression for dynamic instances ===
+
=== Binding expressions for dynamic instances ===
 
1. In order to be able to create a binding expression for an instance in Play-Out, each Dynamic instance should have the following code:
 
1. In order to be able to create a binding expression for an instance in Play-Out, each Dynamic instance should have the following code:
 
  public class BindedButton extends JButton{
 
  public class BindedButton extends JButton{
Line 71: Line 66:
  
  
<big>You are ready to start playing in.</big>
+
You are now ready to start playing in.
 
'''[http://www.youtube.com/watch?v=zelYmRtCJk8 Watch a Demo]'''
 
'''[http://www.youtube.com/watch?v=zelYmRtCJk8 Watch a Demo]'''

Revision as of 12:59, 28 March 2012

Create a new LSC project

From PlayGo perspective: File-->New-->LSC Project

Write your Swing code

Using the WindowBuilder plugin

One possible option for creating the Swing GUI application is to use the WindowBuilder plugin. Follow these instructions:

  1. Install the WindowBuilder plugin from: [1]
  2. Use the System Model view to define the classes and objects that participate in your application.
    1. Classes that have a GUI representation should extend one of the Swing available classes (JButton, JTextField, etc...).
    2. Classes that have a GUI representation should be marked as such (check the 'GUI' radio button, by clicking the corresponding radio button when creating a class).
  3. Create the application window using the WindowBuilder plugin.
    1. Use the "Choose Component" option to choose the classes defined using the System Model.
    2. In the application window->design tab, under the constructor->name field, write the name of the object as was given to it in the System Model (since the System Model object and the GUI component are the exact same object in the application).

Manually writing Java Swing code

  1. You can choose to write the GUI in pure Java Swing code.
  2. Once the code is complete, use the import button from the System Model view to create a System Model from the Java Code.

Make your GUI play-in-able

Right-click your LSC project-->Properties-->PlayGo-->Play-In. Check the "Make GUI Play-in-able" check box:

Play-in-able.jpg

Right-click menu

All public methods that are defined in your component's class will appear in the component's right-click menu during play-in. If you wish to omit one of the methods, do the following:

1. Add import il.ac.wis.cs.gwt.server.stubs.annotation.NonPlayInable; to your class

2. Add the @NonPlayInable annotation before the method you'd like to omit

Supported Swing components and component's default action

All Swing components that are made play-in-able once clicking the "Make GUI play-in-able" check box, are defined in the swingComponents hash table under il.ac.wis.cs.automateplayin.GUIComponents.java in the guitoolkit project. The components are added along with their event listeners and their default action. For example, JButton is added to the hash table as follows:
swingComponents.put(Constants.JBUTTON, new String[]{Constants.ACTION_LISTENER,Constants.CLICK_ACTION});

Components that have no default action are added with no listener and default action; e.g., JLable is added as follows: swingComponents.put(Constants.JLABEL, new String[]{"",""});

Currently, the supported event listeners are Action Listener and Change Listener.

Binding expressions for dynamic instances

1. In order to be able to create a binding expression for an instance in Play-Out, each Dynamic instance should have the following code:

public class BindedButton extends JButton{

static HashMap<String, BindedButton> allButtons= new HashMap<String, BindedButton>();
public BindedButton(String name) { super(); this.name = name; allButtons.put(name, this); }
...
public static BindedButton getButton(String buttonName) { BindedButton button = allButtons.get(buttonName); return button; } }


You are now ready to start playing in. Watch a Demo