Class AdditionalResults

java.lang.Object

org.openjump.sextante.gui.additionalResults.AdditionalResults

public class AdditionalResults
extends Object

This class stores results generated by SEXTANTE geoalgorithms that are neither layers nor tables (i.e text results and charts). They are all stored as java Component objects, so they can be shown in a dialogs. Charts do not have to be modified, since they already extend the Component class. Text strings should be put into some kind of panel or TextArea. This is not done by this class, but should be done by the corresponding post-process task (see {IPostProcessFactory})

Author:

volaya This class is a refactoring of Sextante es.unex.sextante.gui.additionalResults.AdditionalResults It has been extended to OpenJUMP output results objects. Methods to open a frame to show results are added to this class., Giuseppe Aruta [2017-12-12]

Field Summary

Fields

Modifier and Type	Field	Description
static ArrayList<ObjectAndDescription>	m_Components

Constructor Summary

Constructors

Constructor	Description
AdditionalResults()

Method Summary

Modifier and Type	Method	Description
static void	addAdditionalResult(String name, Object object)	Adds a result to Arraylis
static void	addAdditionalResultAndShow(String name, Object object)	Adds a result to Arraylis and opens it into the AdditionalResultFrame Left panel (the list of object) is always visible
static void	addAdditionalResultAndShow(String name, Object object, boolean hideLeftPanel)	Adds a result to Arraylis and opens it into the AdditionalResultFrame
static void	addAdditionalResults(String name, Object[] objects)	Adds the results to Arraylis
static void	addAdditionalResultsAndShow(String name, Object[] objects)	Adds the results to Arraylis and opens it into the AdditionalResultFrame Left panel (the list of object) is always visible
static void	addComponent(ObjectAndDescription oad)	Adds a new component "ObjectAndDescription" and show it into the frame
static void	addComponentAndShow(ObjectAndDescription oad)	Adds a new component "ObjectAndDescription" and show it into the frame
static ArrayList<ObjectAndDescription>	getComponents()	Returns the list of results as a list of components
static void	removeComponent(ObjectAndDescription oad)	Removes a component "ObjectAndDescription" from the ArrayList
static void	showPanel()	Shows a panel with results, only if there is at least one of them,

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

m_Components

public static ArrayList<ObjectAndDescription> m_Components

Constructor Details

AdditionalResults

public AdditionalResults()

Method Details

showPanel

public static void showPanel()

Shows a panel with results, only if there is at least one of them,

getComponents

public static ArrayList<ObjectAndDescription> getComponents()

Returns the list of results as a list of components

Returns:

the list of results

addComponent

public static void addComponent(ObjectAndDescription oad)

Adds a new component "ObjectAndDescription" and show it into the frame

Parameters:

oad - a result and its description, to be shown in the corresponding panel

addComponentAndShow

public static void addComponentAndShow(ObjectAndDescription oad)

Adds a new component "ObjectAndDescription" and show it into the frame

Parameters:

oad - a result and its description, to be shown in the corresponding panel

removeComponent

public static void removeComponent(ObjectAndDescription oad)

Removes a component "ObjectAndDescription" from the ArrayList

Parameters:

oad - The result to remove

addAdditionalResult

public static void addAdditionalResult(String name,
 Object object)

Adds a result to Arraylis

Parameters:

name - the name of the object

object - the object: JPanel, JTextArea, JTextPane, JLabel, JTable, HTMLPanel , PlotPanel and possibly any objects from Sextante

addAdditionalResults

public static void addAdditionalResults(String name,
 Object[] objects)

Adds the results to Arraylis

Parameters:

name - the name of the object

objects - An Array of Object: JPanel, JTextArea, JTextPane, JLabel, JTable, HTMLPanel , PlotPanel and possibly any objects from Sextante. Default syntax is "new Object(){panel1,panel2,...}"

addAdditionalResultAndShow

public static void addAdditionalResultAndShow(String name,
 Object object,
 boolean hideLeftPanel)

Adds a result to Arraylis and opens it into the AdditionalResultFrame

Parameters:

name - the name of the object

object - the object: JPanel, JTextArea, JTextPane, JLabel, JTable, HTMLPanel , PlotPanel and possibly any objects from Sextante

hideLeftPanel - "true": left (list of object) panel is visible, "false": left (list of object) panel is not visible

addAdditionalResultAndShow

public static void addAdditionalResultAndShow(String name,
 Object object)

Adds a result to Arraylis and opens it into the AdditionalResultFrame Left panel (the list of object) is always visible

Parameters:

name - the name of the object

object - the object: JPanel, JTextArea, JTextPane, JLabel, JTable, HTMLPanel , PlotPanel and possibly any objects from Sextante

addAdditionalResultsAndShow

public static void addAdditionalResultsAndShow(String name,
 Object[] objects)

Adds the results to Arraylis and opens it into the AdditionalResultFrame Left panel (the list of object) is always visible

Parameters:

name - the name of the object

objects - An Array of Objects invalid input: '<'JPanel, JTextArea, JTextPane, JLabel, JTable, HTMLPanel , PlotPanel and psibly any objects from JPanel, JTextArea, JTextPane, JLabel, JTable, HTMLPanel , PlotPanel and possibly any objects from Sextante. Default syntax is "new Object(){panel1,panel2,...}"