org.uberfire.ext.plugin.client.perspective.editor.api

Interface ExternalPerspectiveEditorComponent

public interface ExternalPerspectiveEditorComponent

An interface for implementing custom Perspective Editor's component. Any components implementing this interface will be added to the Perspective Editor's widget palette.

Components must provide a Workbench place name plus a widget for editing and configuring the place request parameters. The Perspective Editor will persist the place request created by this component along with the perspective definition. During perspective rendering, the workbench will process every place request found within the perspective.

Method Summary

Modifier and Type	Method and Description
com.google.gwt.user.client.ui.IsWidget	getConfig() The widget in charge of editing the place request parameters.
Map<String,String>	getParametersMap() The place request parameters.
String	getPlaceName() The name of the Workbench Place tied to this external component.
com.google.gwt.user.client.ui.IsWidget	getPreview(Map<String,String> parameters) Provides a quick preview representation of the Place being configured.
void	modalSettings(org.gwtbootstrap3.client.ui.Modal popup) Change the popup widget settings to fit the component editor needs.
void	setup(String placeName, Map<String,String> parameters) Initialize the editor component from an existing place request definition.

Method Detail

setup

void setup(String placeName,
           Map<String,String> parameters)

Initialize the editor component from an existing place request definition.

Parameters:

placeName - The place name

parameters - The place parameters

getPlaceName

String getPlaceName()

The name of the Workbench Place tied to this external component.

Returns:

An existing place name.

getParametersMap

Map<String,String> getParametersMap()

The place request parameters.

getConfig

com.google.gwt.user.client.ui.IsWidget getConfig()

The widget in charge of editing the place request parameters.

It will be added and displayed inside the perspective editor popup panel.

getPreview

com.google.gwt.user.client.ui.IsWidget getPreview(Map<String,String> parameters)

Provides a quick preview representation of the Place being configured.

Parameters:

parameters - The Place request parameters.

modalSettings

void modalSettings(org.gwtbootstrap3.client.ui.Modal popup)

Change the popup widget settings to fit the component editor needs. Basically, the common use of this method is to set the modal's width & height.