DummyPlotter
hep.aida.ref.plotter

Class DummyPlotter

  • All Implemented Interfaces:
    IPlotter
    Direct Known Subclasses:
    Plotter


    public class DummyPlotterextends Objectimplements IPlotter
    A dummy implementation of an AIDA Plotter, useful in batch jobs where no graphical output is required.
    • Method Detail

      • show

        public void show()
        Description copied from interface: IPlotter
        Map the plotter on the screen.
        Specified by:
        show in interface IPlotter
      • hide

        public void hide()
        Description copied from interface: IPlotter
        Unmap the plotter on the screen.
        Specified by:
        hide in interface IPlotter
      • refresh

        public void refresh()
        Description copied from interface: IPlotter
        Refresh the screen window(s). Used when a plotted data analysis object received new data.
        Specified by:
        refresh in interface IPlotter
      • interact

        public void interact()
        Description copied from interface: IPlotter
        Give control to the plotter GUI. The plotter must be able to return from this function from a user action in its GUI.
        Specified by:
        interact in interface IPlotter
      • next

        public IPlotterRegion next()
        Description copied from interface: IPlotter
        Set current region to be the "next" one. If exceeding the number of regions, the current region index return to 0.
        Specified by:
        next in interface IPlotter
        Returns:
        The new current region.
      • createRegion

        public IPlotterRegion createRegion(double x)
        Description copied from interface: IPlotter
        Create a new region.
        Specified by:
        createRegion in interface IPlotter
        Returns:
        The newly created region. Return null in case not failure. Note that the plotter manages the regions ; user does not have to delete a region object directly.
      • createRegion

        public IPlotterRegion createRegion()
        Description copied from interface: IPlotter
        Create a new region. that is to say between 0 and 1. Then a region with (x=0,y=0,w=1,h=1) maps the full page. "x" goes left to right. "y" bottom to top.
        Specified by:
        createRegion in interface IPlotter
        Returns:
        The newly created region. Return null in case not failure. Note that the plotter manages the regions ; user does not have to delete a region object directly.
      • createRegion

        public IPlotterRegion createRegion(double x,                          double y)
        Description copied from interface: IPlotter
        Create a new region.
        Specified by:
        createRegion in interface IPlotter
        Returns:
        The newly created region. Return null in case not failure. Note that the plotter manages the regions ; user does not have to delete a region object directly.
      • createRegion

        public IPlotterRegion createRegion(double x,                          double y,                          double w)
        Description copied from interface: IPlotter
        Create a new region.
        Specified by:
        createRegion in interface IPlotter
        Returns:
        The newly created region. Return null in case not failure. Note that the plotter manages the regions ; user does not have to delete a region object directly.
      • createRegion

        public IPlotterRegion createRegion(double x,                          double y,                          double w,                          double h)
        Description copied from interface: IPlotter
        Create a new region.
        Specified by:
        createRegion in interface IPlotter
        Returns:
        The newly created region. Return null in case not failure. Note that the plotter manages the regions ; user does not have to delete a region object directly.
      • createRegions

        public void createRegions()
        Description copied from interface: IPlotter
        Create a grid of regions. By default the current region is the top left one (with index 0). Region are indexed from zero, with increasing order left to right, top to bottom.
        Specified by:
        createRegions in interface IPlotter
      • createRegions

        public void createRegions(int columns)
        Description copied from interface: IPlotter
        Create a grid of regions. By default the current region is the top left one (with index 0). Region are indexed from zero, with increasing order left to right, top to bottom.
        Specified by:
        createRegions in interface IPlotter
      • createRegions

        public void createRegions(int columns,                 int rows)
        Description copied from interface: IPlotter
        Create a grid of regions. By default the current region is the top left one (with index 0). Region are indexed from zero, with increasing order left to right, top to bottom.
        Specified by:
        createRegions in interface IPlotter
      • createRegions

        public void createRegions(int columns,                 int rows,                 int start)
        Description copied from interface: IPlotter
        Create a grid of regions. By default the current region is the top left one (with index 0). Region are indexed from zero, with increasing order left to right, top to bottom.
        Specified by:
        createRegions in interface IPlotter
        start - Set the current region.
      • setCurrentRegionNumber

        public void setCurrentRegionNumber(int value)
        Description copied from interface: IPlotter
        Set current region by giving its index [0,n-1]
        Specified by:
        setCurrentRegionNumber in interface IPlotter
      • currentRegionNumber

        public int currentRegionNumber()
        Specified by:
        currentRegionNumber in interface IPlotter
        Returns:
        The current region index.
      • destroyRegions

        public void destroyRegions()
        Description copied from interface: IPlotter
        Destroy regions.
        Specified by:
        destroyRegions in interface IPlotter
      • clearRegions

        public void clearRegions()
        Description copied from interface: IPlotter
        Clear all regions. It does not reset the number and position of regions. This can be done through a destroyRegions.
        Specified by:
        clearRegions in interface IPlotter
      • numberOfRegions

        public int numberOfRegions()
        Specified by:
        numberOfRegions in interface IPlotter
        Returns:
        The number of regions.
      • setTitle

        public void setTitle(String str)
        Description copied from interface: IPlotter
        Set the global title of the plotter (page).
        Specified by:
        setTitle in interface IPlotter
      • title

        public String title()
        Description copied from interface: IPlotter
        Get the global title of the plotter (page).
        Specified by:
        title in interface IPlotter
      • writeToFile

        public void writeToFile(String file,               String type)                 throws IOException
        Description copied from interface: IPlotter
        Produce an output file.
        Specified by:
        writeToFile in interface IPlotter
        type - A string to describe the type of the output : "PS" or "PostScript" for PostScript, "JPEG" for JPEG. If nothing is given, the type is guessed from the given file name suffix (.ps for PostScript, .jpg for JPEG, etc...).
        Throws:
        IOException
      • isShowing

        public boolean isShowing()
      • invokeOnSwingThread

        public static void invokeOnSwingThread(Runnable run)

SCaVis 2.0 © jWork.ORG