1. Documentation
2. 10.1 (Latest)10.09.109.99.89.79.69.59.49.39.29.19.08.28.18.07.6
3. Developers
4. Extensions
5. Advanced enhancements
6. Custom UI elements

Adding Custom User Interface Elements

Learn how to add custom panels to the UI of RapidMiner Studio and how to modify thePreferencesdialog to your needs.

Adding custom panels

The PluginInit class offers the ability to modify the GUI. We will add a single new window here for demonstration purpose. All we have to do is to implement a new class implementing theDockableinterface and a component that is delivered by theDockable.

public class SimpleWindow extends JPanel implements Dockable { private static final long serialVersionUID = 1L; private static final DockKey DOCK_KEY = new ResourceDockKey("tutorial.simple_window"); private JLabel label = new JLabel("Hello user."); /** * Constructor for a {@link SimpleWindow}. */ public SimpleWindow() { // adding content to this window setLayout(new BorderLayout()); add(label, BorderLayout.CENTER); } /** * Sets the simple window label * * @param labelText * the text to show */ public void setLabel(String labelText) { this.label.setText(labelText); System.out.println(labelText); revalidate(); } @Override public Component getComponent() { return this; } @Override public DockKey getDockKey() { return DOCK_KEY; } }

While the content of the window is rather simple and only a variant of the well-known 'Hello world' program, it illustrates the concept of theResourceDockKey. ADockKeycontains information about aDockable, for example it stores the name and the icon of the window. TheResourceDockKeyretrieves this information from the GUI resource bundle that is loaded in a language dependent manner from the resource fileGUIXXX.xmlwhere 'XXX' is the extension name. The following is an example of what might describe the new window:

gui.dockkey.tutorial.simple_window.name = A simple Window gui.dockkey.tutorial.simple_window.icon = window2.png gui.dockkey.tutorial.simple_window.tip = Take a look at what RapidMiner has to say.

In the example, the iconwindow2.pnghas been added to the foldericons/16in the乐鱼体育安装folder of your extension, making it available when starting RapidMiner. The final task before seeing the new window is to register it at RapidMiner'sMainFrame. You want to do this independent of operator execution, and in fact, want to have the window before any process is executed. To do so, use one of thePluginInithooks, so we are going to fill theinitGuimethod:

公共静态孔隙initGui(MainFrame mainframe) { mainframe.getDockingDesktop().registerDockable(new SimpleWindow();); }

That's it! You can now select the new panel from theView > Show Panelmenu. The result looks like this:

Adding custom settings to the Preferences dialog

Open theSettings > Preferencesmenu and look at the existing preferences dialog. As you can see, there are several tabs that contain specific settings that the user can make. For your extension, you can create your own tab.

Complete these three steps to build your own tab in thePreferencesdialog:

1. Adapt the filesettingsNAME.xml, where 'NAME' is the name of your extension. Then, specify keys for the tab name and the single preferences you want to add. For example:

2. Adapt the fileSettingsNAME.properties, where 'NAME' is again the name of your extension. Specify names for the keys that you defined in the first step.

   extension_name.title = My Extension extension_name.description = extension_name.url.title = A Server URL extension_name.url.description = Default value of a server URL

3. Change the methodinitPlugin()in yourPluginInitclass and register the settings that you want to add to thePreferencesdialog.

   public static void initPlugin() { ParameterService.registerParameter( new ParameterTypeString( "extension_name.url", "The server URL","http://localhost:8080")); }

If you want to use a boolean setting (a check box), register it like this:

ParameterService.registerParameter( new ParameterTypeBoolean("extension_name.url","Use a URL?", false));