com.highqsoft.interfaces.p2d

Interface P2DPlotInterface

All Superinterfaces:

java.awt.datatransfer.ClipboardOwner, java.lang.Comparable, javax.infobus.DataItem, FwkAppearanceInterface, FwkCompareInterface, FwkControllerInterface, FwkDescriptionInterface, FwkDOMHandlerInterface, FwkInfoBusMemberInterface, FwkInstructionInterface, FwkInterface, FwkItemInterface, FwkPersistenceInterface, FwkPresentationInterface, FwkPropertyChangeInterface, FwkTransferableInterface, FwkVetoableChangeInterface, javax.infobus.InfoBusMember, P2DComponentControlInterface, P2DComponentInterface, P2DComponentModelInterface, P2DComponentViewInterface, P2DContainerInterface, java.io.Serializable, java.awt.datatransfer.Transferable

All Known Implementing Classes:

P2DPlot

public interface P2DPlotInterface
extends P2DComponentInterface

The P2DPlotInterface describes the functionality of a P2D package plot component.

Since:

$Date: 2017/04/06 13:30:05 $

Version:

$Revision: 1.10 $

Author:

Andreas Hofmann

Field Summary

Fields inherited from interface com.highqsoft.interfaces.p2d.P2DComponentInterface

CONTROL_KEY, MODEL_KEY, VIEW_KEY

Fields inherited from interface com.highqsoft.interfaces.fwk.FwkItemInterface

INFOBUS_SOURCE

Fields inherited from interface com.highqsoft.interfaces.fwk.FwkDescriptionInterface

AUTHOR, BUILDNR, COMPANY, COPYRIGHT, DATE_FORMAT, DEFAULT_ICON, DESCRIPTION, INTERNET, LARGE_ICON, LARGE_KEY_EXT, LARGE_OPAQUE_ICON, LARGE_OPAQUE_KEY_EXT, OPAQUE_ICON, OPAQUE_KEY_EXT, RCS_DATE_FORMAT, SUPPORT_EMAIL, TITLE_NAME

Fields inherited from interface com.highqsoft.interfaces.fwk.FwkAppearanceInterface

DASH_STROKE, DOT_DASH_STROKE, DOT_DOT_DASH_STROKE, DOT_STROKE, LINE_STROKE

Method Summary

Methods

Modifier and Type	Method and Description
P2DChannelInterface[]	addChannelComponent(java.lang.String yName) Add a channel component.
P2DChannelInterface[]	addChannelComponent(java.lang.String xName, java.lang.String yName) Add a channel component to the plot model.
void	clearChannelComponents() Clear all channel components.
P2DAxisInterface[]	getAllYAxisComponents() Retrieve the all y-axis components.
P2DChannelInterface	getChannelComponent() Retrieve the channel component.
P2DChannelInterface	getChannelComponent(java.lang.String yName) Retrieve the channel component.
P2DChannelInterface[]	getChannelComponents() Retrieve all channel components.
boolean	getHorizontalTile() Get the horizontal tile flag.
P2DLegendInterface	getLegendComponent() Retrieves the P2D legend component.
boolean	getLegendEnabled() Get the boolean whether the legend is enabled.
P2DMarkerInterface	getMarkerComponent() Get the marker component.
boolean	getSingleScale() Get a boolean that indicates a single y scaling.
P2DTextInterface	getTitleComponent() Retrieves the P2D text component used as title.
boolean	getVerticalTile() Get the vertical tile flag.
P2DAxisInterface	getXAxisComponent() Retrieve the x-axis component.
java.lang.String	getXChannelName() Get the name of the x Channel.
P2DAxisInterface	getYAxisComponent() Retrieve the y-axis component.
P2DAxisInterface	getYAxisComponent(java.lang.String yName) Retrieve the y-axis component.
boolean	hasChannels() Return a boolean whether the plot contains channels.
void	nextXRangeStep() Set the range to the next x range step.
void	nextXRangeWindow() Set the range to the next x range window.
void	prevXRangeStep() Set the range to the prev x range step.
void	prevXRangeWindow() Set the range to the prev x range window.
P2DChannelInterface[]	setChannelComponent(java.lang.String yName) Set the channel component.
P2DChannelInterface[]	setChannelComponent(java.lang.String xName, java.lang.String yName) Set the channel component.
void	setFullXResolution(P2DContainerInterface container) Set the range so that the full resolution is use for display plot in x direction.
void	setHorizontalTile(boolean flag) Set the horizontal tile flag.
P2DLegendInterface	setLegendComponent(P2DLegendInterface legend) Set the legend of the plot.
void	setLegendEnabled(boolean flag) Enable the legend.
void	setSingleScale(boolean flag) Set a boolean for signle scaling.
P2DTextInterface	setTitleComponent(FwkArrayInterface arr) Set the title of the plot.
P2DTextInterface	setTitleComponent(P2DTextInterface text) Set the title of the plot.
P2DTextInterface	setTitleComponent(java.lang.String title) Set the title of the plot.
void	setVerticalTile(boolean flag) Set the vertical tile flag.
void	setXAutoRange() Set x auto ragne mode.
void	setXChannelName(java.lang.String xName) Set the name of the x Channel.
void	setYAutoRange() Set y auto ragne mode.
void	toBeginOfXRange() Set the upper range value to the begin of autorange value.
void	toEndOfXRange() Set the lower range value to the end of autorange value.
void	zoomXIn() Zoom into the x axis.
void	zoomXOut() Zoom out the x axis.

Methods inherited from interface com.highqsoft.interfaces.p2d.P2DComponentInterface

askForName, calculateBoundingBoxRelativeTo, getControl, getControlClassId, getDialogPane, getDialogPanes, getDialogPaneValue, getDialogPaneValues, getInternalMouseListenerActive, getModel, getModelClassId, getRegisterCounter, getView, getViewClassId, initialize, isInternalMouseListenerActive, isMVCValid, loadControl, loadModel, loadView, paint, paint, processFocusEvent, processMouseEvent, register, setControl, setControlClassId, setDialogPaneValues, setInternalMouseListenerActive, setModel, setModelClassId, setView, setViewClassId, unregister, unregister, update, updateControl, updateModel, updateView

Methods inherited from interface com.highqsoft.interfaces.p2d.P2DContainerInterface

addContainerListener, addFocusListener, addListener, addMouseListener, addMouseMotionListener, addOrderListener, addP2D, addP2D, addP2D, addP2D, addRepaintListener, fireOrderEvent, getActive, getActiveComponent, getAllArmedComponents, getAllArmedComponents, getArmedComponent, getComponentCommands, getContainerListenerArray, getFocusListenerArray, getListenerArray, getMouseListenerArray, getMouseMotionListenerArray, getOrderListenerArray, getP2D, getP2D, getP2D, getP2DComponentArray, getP2DComponents, getParentContainer, getRepaintListenerArray, getSelectable, getShortName, getTreeLock, openPopupMenu, removeAllP2D, removeContainerListener, removeFocusListener, removeListener, removeMouseListener, removeMouseMotionListener, removeOrderListener, removeP2D, removeP2D, removeRepaintListener, repaint, restoreLastMouseEvent, restoreLocalMousePoint, revalidate, saveLastMouseEvent, saveLocalMousePoint, setActive, setActiveComponent, setParentContainer, setSelectable, toBack, toBack, toBack, toFront, toFront, toFront

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkInfoBusMemberInterface

getInfoBusName, getMemberName, isConnected, setInfoBusName, setMemberName

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkItemInterface

fireItemAdded, fireItemDeleted, fireItemRevoked, fireItemValueChanged, getProperty, getPropertyGroup, setProperty, setPropertyGroup, suspendChangeManager

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkPersistenceInterface

getCommands, getPersistentObjectNames

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkControllerInterface

destroyController

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkPropertyChangeInterface

addPropertyChangeListener, addPropertyChangeListener, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getPropertyChangeArray, getPropertyChangeListenerArray, getPropertyChangeListenerArray, isPropertyChangeEventSuspended, removePropertyChangeListener, removePropertyChangeListener, setSource, suspendPropertyChangeEvents

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkVetoableChangeInterface

addVetoableChangeListener, addVetoableChangeListener, getVetoableChangeArray, getVetoableChangeListenerArray, getVetoableChangeListenerArray, removeVetoableChangeListener, removeVetoableChangeListener

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkDescriptionInterface

getAuthor, getBuild, getClassName, getCompany, getCompanyInternetAddress, getCopyright, getCreationDate, getCreationDate, getDateFormatString, getDescription, getIcon, getIcon, getIconKey, getIconKey, getName, getPresentationString, getPresentationString, getSupportEMail, getTitle, getTitleName, setAuthor, setBuild, setClassName, setCompany, setCompanyInternetAddress, setCopyright, setCreationDate, setCreationDate, setDateFormatString, setDescription, setDescriptor, setIcon, setIcon, setIconKey, setIconKey, setName, setSupportEMail, setTitleName

Methods inherited from interface java.awt.datatransfer.Transferable

getTransferData, getTransferDataFlavors, isDataFlavorSupported

Methods inherited from interface java.awt.datatransfer.ClipboardOwner

lostOwnership

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkInstructionInterface

addCommand, addCommand, addToGroup, addToGroup, clearCommands, commandsAvailable, deleteGroup, getCommand, getCommands, getGroup, groupExists, removeCommand, removeFromGroup, setCommands

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkPresentationInterface

getPresentationString, getPresentationString

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkInterface

getVersion, release

Methods inherited from interface javax.infobus.DataItem

getSource, release

Methods inherited from interface javax.infobus.InfoBusMember

addInfoBusPropertyListener, addInfoBusVetoableListener, getInfoBus, removeInfoBusPropertyListener, removeInfoBusVetoableListener, setInfoBus

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkDOMHandlerInterface

getCompany, readConstructor, readFromDOM, readingDOM, readingDOM, writeConstructor, writeToDOM, writeToXML

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkAppearanceInterface

configure, getBackgroundColor, getClip, getColor, getDashArray, getDashPhase, getEndCap, getFill, getFont, getLineJoin, getLineWidth, getMiterLimit, getStroke, getTransform, getTranslation, getTransparency, getVisible, isVisible, scaleStroke, scaleStroke, setBackgroundColor, setClip, setClip, setColor, setDashArray, setDashPhase, setEndCap, setFill, setFont, setLineJoin, setLineWidth, setMiterLimit, setScale, setStroke, setTransform, setTranslation, setTransparency, setVisible

Methods inherited from interface com.highqsoft.interfaces.p2d.P2DComponentModelInterface

addDialogPane, boundsAcceptable, containsAllChildren, containsAllChildren, frameHasHandles, getActive, getActiveHandle, getAppearance, getBackground, getBackgroundColor, getBackgroundTransparency, getBackgroundVisible, getBoundingBox, getChild, getChild, getContainerMap, getDecorated, getFrame, getFrameColor, getFrameHandlesVisible, getFrameLinesVisible, getFrameTransparency, getFrameVisible, getHeight, getRatioFix, getTransform, getWidth, hasActiveChild, isInside, isInside, registerContainer, removeDialogPane, resetActiveHandle, revalidate, scaleStroke, scaleStroke, setActive, setActiveHandle, setAppearance, setBackgroundColor, setBackgroundTransparency, setBackgroundVisible, setBoundingBox, setContainerMap, setDecorated, setFrameColor, setFrameHandlesVisible, setFrameLinesVisible, setFrameTransparency, setFrameVisible, setRatioFix, setTransform, transformPoint, transformPoint, unregisterContainer

Methods inherited from interface com.highqsoft.interfaces.p2d.P2DComponentControlInterface

focusGained, focusLost, mouseClicked, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased

Method Detail

setTitleComponent

P2DTextInterface setTitleComponent(java.lang.String title)

Set the title of the plot.

Parameters:

title - The title string.

Returns:

the created component.

setTitleComponent

P2DTextInterface setTitleComponent(FwkArrayInterface arr)

Set the title of the plot.

Parameters:

arr - an array containing the title stings.

setTitleComponent

P2DTextInterface setTitleComponent(P2DTextInterface text)

Set the title of the plot.

Parameters:

text - The P2D text component used as title.

getTitleComponent

P2DTextInterface getTitleComponent()

Retrieves the P2D text component used as title.

Returns:

The P2D text component used as title.

setLegendComponent

P2DLegendInterface setLegendComponent(P2DLegendInterface legend)

Set the legend of the plot.

Parameters:

legend - The P2D legend component.

getLegendComponent

P2DLegendInterface getLegendComponent()

Retrieves the P2D legend component.

Returns:

The P2D legend component.

clearChannelComponents

void clearChannelComponents()

Clear all channel components.

addChannelComponent

P2DChannelInterface[] addChannelComponent(java.lang.String xName,
                                        java.lang.String yName)

Add a channel component to the plot model.

Parameters:

xName - The name of the channel to be added.

yName - The name of the channel to be added.

addChannelComponent

P2DChannelInterface[] addChannelComponent(java.lang.String yName)

Add a channel component.

Parameters:

yName - The name of the channel to be displayed as y-channel versus index.

setChannelComponent

P2DChannelInterface[] setChannelComponent(java.lang.String yName)

Set the channel component.

Parameters:

yName - The name of the channel to be displayed as y-channel versus index.

setChannelComponent

P2DChannelInterface[] setChannelComponent(java.lang.String xName,
                                        java.lang.String yName)

Set the channel component.

Parameters:

xName - The name of the channel to be displayed as x-channel.

yName - The name of the channel to be displayed as y-channel.

getChannelComponent

P2DChannelInterface getChannelComponent()

Retrieve the channel component.

Returns:

the channel component of the plot.

hasChannels

boolean hasChannels()

Return a boolean whether the plot contains channels.

Returns:

true if the plot has any channel.

getChannelComponents

P2DChannelInterface[] getChannelComponents()

Retrieve all channel components.

Returns:

all known channels.

getChannelComponent

P2DChannelInterface getChannelComponent(java.lang.String yName)

Retrieve the channel component.

Parameters:

yName - the name of the channel for that the component should be returned.

Returns:

the channel component of the plot.

getXAxisComponent

P2DAxisInterface getXAxisComponent()

Retrieve the x-axis component.

Returns:

the x-axis component of the plot.

getYAxisComponent

P2DAxisInterface getYAxisComponent()

Retrieve the y-axis component.

Returns:

the y-axis component of the plot.

getAllYAxisComponents

P2DAxisInterface[] getAllYAxisComponents()

Retrieve the all y-axis components.

Returns:

an array containing all y-axis components of the plot.

getYAxisComponent

P2DAxisInterface getYAxisComponent(java.lang.String yName)

Retrieve the y-axis component.

Parameters:

yName - the name of the channel for that the component should be returned.

Returns:

the y-axis component of the plot.

getMarkerComponent

P2DMarkerInterface getMarkerComponent()

Get the marker component.

Returns:

The marker component.

zoomXIn

void zoomXIn()

Zoom into the x axis.

zoomXOut

void zoomXOut()

Zoom out the x axis.

setXAutoRange

void setXAutoRange()

Set x auto ragne mode.

setYAutoRange

void setYAutoRange()

Set y auto ragne mode.

toEndOfXRange

void toEndOfXRange()

Set the lower range value to the end of autorange value.

toBeginOfXRange

void toBeginOfXRange()

Set the upper range value to the begin of autorange value.

nextXRangeWindow

void nextXRangeWindow()

Set the range to the next x range window.

prevXRangeWindow

void prevXRangeWindow()

Set the range to the prev x range window.

nextXRangeStep

void nextXRangeStep()

Set the range to the next x range step.

prevXRangeStep

void prevXRangeStep()

Set the range to the prev x range step.

setFullXResolution

void setFullXResolution(P2DContainerInterface container)

Set the range so that the full resolution is use for display plot in x direction.

setXChannelName

void setXChannelName(java.lang.String xName)

Set the name of the x Channel.

Parameters:

xName - the name of the x channel.

getXChannelName

java.lang.String getXChannelName()

Get the name of the x Channel.

Returns:

the name of the x channel.

getHorizontalTile

boolean getHorizontalTile()

Get the horizontal tile flag.

Returns:

if the multiple channels are horizontal tiled.

setHorizontalTile

void setHorizontalTile(boolean flag)

Set the horizontal tile flag.

Parameters:

flag - if the multiple channels are horizontal tiled.

getSingleScale

boolean getSingleScale()

Get a boolean that indicates a single y scaling.

Returns:

if if there is one y-axis only.

setSingleScale

void setSingleScale(boolean flag)

Set a boolean for signle scaling.

Parameters:

flag - if the plot will have only one single scaled y-axis.

getVerticalTile

boolean getVerticalTile()

Get the vertical tile flag.

Returns:

if the multiple channels are vertical tiled.

setVerticalTile

void setVerticalTile(boolean flag)

Set the vertical tile flag.

Parameters:

flag - if the multiple channels are vertical tiled.

setLegendEnabled

void setLegendEnabled(boolean flag)

Enable the legend.

Parameters:

flag - if true the legend is enabled.

getLegendEnabled

boolean getLegendEnabled()

Get the boolean whether the legend is enabled.

Returns:

true if the legend is enabled.