public abstract class PlotRender
extends java.lang.Object
IPlot
.
After creating a PlotRender
, its content will need to be created via
createBasicContent()
. It can be updated later by calling
refresh()
.
Sub-classes should implement the required methods to populate/update the
plotComposite
and may also override the methods that populate/update
the infoComposite
to add extra informational features as necessary.
Modifier and Type | Field and Description |
---|---|
org.eclipse.swt.widgets.Composite |
parent
The parent
Composite that contains the plot render. |
IPlot |
plot
The rendered
IPlot . |
Constructor and Description |
---|
PlotRender(org.eclipse.swt.widgets.Composite parent,
IPlot plot)
The default constructor.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getPlotCategory()
Gets the current plot category.
|
java.lang.String |
getPlotType()
Gets the current plot type.
|
void |
refresh()
This method updates the UI widgets based on the current settings.
|
void |
refresh(boolean clearCache)
This method updates the UI widgets based on the current settings.
|
void |
setPlotCategory(java.lang.String category)
Sets the current plot category.
|
void |
setPlotType(java.lang.String type)
Sets the current plot type.
|
public final org.eclipse.swt.widgets.Composite parent
Composite
that contains the plot render.public final IPlot plot
IPlot
. This cannot be changed.public PlotRender(org.eclipse.swt.widgets.Composite parent, IPlot plot)
parent
- The parent Composite
that contains the plot render.plot
- The rendered IPlot
. This cannot be changed.public void setPlotCategory(java.lang.String category)
Note: A subsequent call to refresh()
will be necessary to
sync the UI with this call's changes.
category
- The new plot category.public void setPlotType(java.lang.String type)
Note: A subsequent call to refresh()
will be necessary to
sync the UI with this call's changes.
type
- The new plot type.public java.lang.String getPlotCategory()
public java.lang.String getPlotType()
public void refresh()
refresh(false)
.
This will either immediately update the UI or trigger an asynchronous update to the UI on the display's UI thread.
public void refresh(boolean clearCache)
This will either immediately update the UI or trigger an asynchronous update to the UI on the display's UI thread.
clearCache
- Some sub-classes may cache certain meta data so that the
refresh operation is faster. If true, this parameter causes
the cached information to be rebuilt at the next available
opportunity.