hep.wired.heprep.plugin

Class WiredPlugin

java.lang.Object

org.freehep.application.studio.Plugin

hep.wired.heprep.plugin.WiredPlugin

All Implemented Interfaces:

hep.graphics.heprep.HepRepViewer, org.freehep.jas.plugin.xmlio.XMLPluginIO

public class WiredPlugin
extends org.freehep.application.studio.Plugin
implements hep.graphics.heprep.HepRepViewer, org.freehep.jas.plugin.xmlio.XMLPluginIO

Defines the plugin for use in JAS3.

Version:

$Id: WiredPlugin.java 15212 2013-05-28 06:50:47Z onoprien $

Author:

Mark Donszelmann, Dmitry Onoprienko

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WiredPlugin.IH Enumeration of InteractionHandlers used by WIRED.

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_ROOT

Fields inherited from interface org.freehep.jas.plugin.xmlio.XMLPluginIO

RESTORE_DATA, RESTORE_DONE, RESTORE_FINALIZE, RESTORE_PAGES, RESTORE_PLOT_DATA_SOURCES, RESTORE_PLOTS_IN_PAGES, RESTORE_TREE_OBJECTS, RESTORE_TREE_STRUCTURE

Constructor Summary

Constructors

Constructor and Description
WiredPlugin()

Method Summary

Methods

Modifier and Type	Method and Description
void	checkHepRep(hep.graphics.heprep.HepRep heprep)
WiredPage	createWiredView(String name, hep.graphics.heprep.HepRep event, HepRepPanel panel, boolean clone) Creates a new WIRED plot.
void	display(hep.graphics.heprep.HepRep event)
ControlPanel	getControlPanel() Returns current control page, null if no control page is available.
org.freehep.application.mdi.PageContext	getCurrentPageContext()
CutPanel	getCutPanel()
HepRepGraphicsMode	getGraphicsMode() Returns default graphics mode.
HepRepInfoPanel	getHepRepInfoPanel()
InteractionHandler	getInteractionHandler() Returns current interaction handler.
InteractionPanel	getInteractionPanel()
int	getNumberOfPlots()
WiredPlot	getPlot() Returns current WiredPlot, null if there is none.
List<HepRepPanelModel>	getPlotModels() Returns a list of all plot models that are attached to plots.
static WiredPlugin	getPlugin()
Properties	getProperties() Returns user properties for this plugin.
hep.graphics.heprep.HepRep	getRecord() Returns currently loaded HepRep record.
TreePanel	getTreePanel()
List	getVariables()
protected void	init()
protected void	postInit()
int	restore(int level, org.freehep.xml.io.XMLIOManager manager, org.jdom.Element el)
void	save(org.freehep.xml.io.XMLIOManager manager, org.jdom.Element el)
void	setControlPanel(ControlPanel control) Sets current control panel.
void	setControlPanel(ControlPanel control, boolean switchInteractionHandler) Sets current control panel.
void	setInteractionHandler(InteractionHandler handler) Sets current interaction handler.
void	setPropertiesPrefix(String prefix) Sets prefix to be appended to properties used by this plugin before they are saved into application properties.
void	showWired(WiredPage wiredPage, Icon icon, boolean attachToLoop)
protected void	shutdown()

Methods inherited from class org.freehep.application.studio.Plugin

addMenu, applicationVisible, canBeShutDown, getApplication

Methods inherited from class java.lang.Object

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

Field Detail

KEY_ROOT

public static final String KEY_ROOT

See Also:

Constant Field Values

Constructor Detail

WiredPlugin

public WiredPlugin()

Method Detail

getPlugin

public static WiredPlugin getPlugin()

init

protected void init()
             throws SAXException,
                    IOException

Overrides:

init in class org.freehep.application.studio.Plugin

Throws:

SAXException

IOException

postInit

protected void postInit()

Overrides:

postInit in class org.freehep.application.studio.Plugin

shutdown

protected void shutdown()

Overrides:

shutdown in class org.freehep.application.studio.Plugin

setInteractionHandler

public void setInteractionHandler(InteractionHandler handler)

Sets current interaction handler.

setControlPanel

public void setControlPanel(ControlPanel control)

Sets current control panel.

setControlPanel

public void setControlPanel(ControlPanel control,
                   boolean switchInteractionHandler)

Sets current control panel. If switchInteractionHandler is true, also sets the control panel's default interaction handler as the current interaction handler.

getPlotModels

public List<HepRepPanelModel> getPlotModels()

Returns a list of all plot models that are attached to plots.

getInteractionPanel

public InteractionPanel getInteractionPanel()

getTreePanel

public TreePanel getTreePanel()

getHepRepInfoPanel

public HepRepInfoPanel getHepRepInfoPanel()

getCutPanel

public CutPanel getCutPanel()

getGraphicsMode

public HepRepGraphicsMode getGraphicsMode()

Returns default graphics mode.

getCurrentPageContext

public org.freehep.application.mdi.PageContext getCurrentPageContext()

getControlPanel

public ControlPanel getControlPanel()

Returns current control page, null if no control page is available.

getInteractionHandler

public InteractionHandler getInteractionHandler()

Returns current interaction handler.

getPlot

public WiredPlot getPlot()

Returns current WiredPlot, null if there is none.

getRecord

public hep.graphics.heprep.HepRep getRecord()

Returns currently loaded HepRep record.

setPropertiesPrefix

public void setPropertiesPrefix(String prefix)

Sets prefix to be appended to properties used by this plugin before they are saved into application properties.

getProperties

public Properties getProperties()

Returns user properties for this plugin.

createWiredView

public WiredPage createWiredView(String name,
                        hep.graphics.heprep.HepRep event,
                        HepRepPanel panel,
                        boolean clone)

Creates a new WIRED plot.

Parameters:

name - Name of the created plot. If null, the plot name will be set to "View N" (plot with a new model) or "-N" (plot with existing model).

event - Record to be displayed by the created plot.

panel - Graphics panel to be used for choosing initial parameters for the new plot.

clone - If true, the newly created plot will share model with the specified panel; if false, a copy of the supplied panel's model will be created. Ignored if panel is null.

showWired

public void showWired(WiredPage wiredPage,
             Icon icon,
             boolean attachToLoop)

getNumberOfPlots

public int getNumberOfPlots()

display

public void display(hep.graphics.heprep.HepRep event)

Specified by:

display in interface hep.graphics.heprep.HepRepViewer

save

public void save(org.freehep.xml.io.XMLIOManager manager,
        org.jdom.Element el)

Specified by:

save in interface org.freehep.jas.plugin.xmlio.XMLPluginIO

restore

public int restore(int level,
          org.freehep.xml.io.XMLIOManager manager,
          org.jdom.Element el)

Specified by:

restore in interface org.freehep.jas.plugin.xmlio.XMLPluginIO

getVariables

public List getVariables()

checkHepRep

public void checkHepRep(hep.graphics.heprep.HepRep heprep)