The User Interface for Yellowfin plug-ins are built by using or extending classes in the Parameter API.
There are four levels of hierarchy for building UI. The diagram below explains these levels:
Parameter Panel Collection
This is the outermost container of the UI and is described by abstract class ParameterPanelCollection. This usually represents a collection of tabs. Implementing classes must override a few methods and are described in the javadoc. The important members in this collection are listed below:
| Method | Description |
|---|---|
| public List<ParameterPanel> getPanels() | Override this method to return a list of panels (tabs) within the ParameterPanelCollection. |
| public String getParameterPanelCollectionClassName() | Return a CSS class name to be applied to the Panel Collection. |
| protected Map<String, Map<String, ?>> data | This member variable is meant for holding data from the Panels within the Panel Collection. The toJSON() method populates it. Implementations may change what’s in this object by overriding getData(). |
| public Map<String, ?> getData() | The default implementation returns the member variable data. A subclass of ParameterPanelCollection may override to modify it. toJSON()converts whatever getData() returns to JSON. |
public JSONObject toJSON() | This method converts everything in the Panel Collection to a org.json.JSONObject (Jackson). The attributes of the object are name, description, panels, data and parameterPanelCollectionClassName. panels holds a JSONArray of JSONObjects returned by each ParameterPanel. |
| protected byte[] getFile(Integer fileId) protected String getText(Integer textId) |
|