jsynoptic.builtin
Class PlotTemplate

java.lang.Object
  extended by jsynoptic.base.Template
      extended by jsynoptic.base.GridShapesTemplate
          extended by jsynoptic.builtin.PlotTemplate

public class PlotTemplate
extends GridShapesTemplate

An abstract template dedicated to create grid of plots or time plots

Author:
zxpletran007

Nested Class Summary
protected  class PlotTemplate.PlotGridShapesTemplatePanel
           
 
Nested classes/interfaces inherited from class jsynoptic.base.GridShapesTemplate
GridShapesTemplate.GridShapesTemplatePanel
 
Nested classes/interfaces inherited from class jsynoptic.base.Template
Template.EmptySheetTemplate, Template.TemplatePanel
 
Field Summary
protected  DataSource defaultPrimaryXDataSource
          An optional default DataSource for each X axis plots.
protected  boolean isTimePlot
          If true, create a TimePlot, otherwise create a standard plot
protected  PlotTemplate.PlotGridShapesTemplatePanel plotGridShapePanel
           
static MenuResourceBundle resources
           
 
Fields inherited from class jsynoptic.base.GridShapesTemplate
BORDER_X_MARGIN, BORDER_Y_MARGIN, colMargin, DEFAULT_COLUMN_MARGIN, DEFAULT_COLUMN_NUMBER, DEFAULT_ROW_MARGIN, DEFAULT_ROW_NUMBER, gridShapePanel, nbColumns, nbRows, rowMargin
 
Fields inherited from class jsynoptic.base.Template
currentTemplate, defaultTemplate, templates
 
Constructor Summary
PlotTemplate()
           
 
Method Summary
protected  AbstractShape createShape(int ox, int oy, int width, int height)
          Shall be overwriten in subclasses Create and set a shape to be added into the grid
 java.lang.String getName()
          Get template name
 Template.TemplatePanel getOptionPanelForTemplate()
          Enables a template to show an option panel to customize template parameters.
 java.lang.String getTemplateInformation()
          Provides information about the template utilization
 
Methods inherited from class jsynoptic.base.GridShapesTemplate
setShapeContainer
 
Methods inherited from class jsynoptic.base.Template
createShapeContainer, getCurrentTemplate, getIcon, getTemplateFromId, getTemplates, setCurrentTemplate, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

resources

public static MenuResourceBundle resources

defaultPrimaryXDataSource

protected DataSource defaultPrimaryXDataSource
An optional default DataSource for each X axis plots. If null, plot X axis are not set


isTimePlot

protected boolean isTimePlot
If true, create a TimePlot, otherwise create a standard plot


plotGridShapePanel

protected PlotTemplate.PlotGridShapesTemplatePanel plotGridShapePanel
Constructor Detail

PlotTemplate

public PlotTemplate()
Method Detail

getName

public java.lang.String getName()
Description copied from class: Template
Get template name

Specified by:
getName in class Template
Returns:
template name

getTemplateInformation

public java.lang.String getTemplateInformation()
Description copied from class: Template
Provides information about the template utilization

Specified by:
getTemplateInformation in class Template
Returns:

createShape

protected AbstractShape createShape(int ox,
                                    int oy,
                                    int width,
                                    int height)
Description copied from class: GridShapesTemplate
Shall be overwriten in subclasses Create and set a shape to be added into the grid

Specified by:
createShape in class GridShapesTemplate
Returns:
a new shape to be added into the grid

getOptionPanelForTemplate

public Template.TemplatePanel getOptionPanelForTemplate()
Description copied from class: Template
Enables a template to show an option panel to customize template parameters.

Overrides:
getOptionPanelForTemplate in class Template
Returns:
a component to display