com.highqsoft.interfaces.p2d

Interface P2DPlotModelInterface

All Superinterfaces:

java.awt.datatransfer.ClipboardOwner, java.lang.Comparable, javax.infobus.DataItem, FwkCompareInterface, FwkControllerInterface, FwkDescriptionInterface, FwkInfoBusMemberInterface, FwkInstructionInterface, FwkInterface, FwkItemInterface, FwkPersistenceInterface, FwkPresentationInterface, FwkPropertyChangeInterface, FwkTransferableInterface, FwkVetoableChangeInterface, javax.infobus.InfoBusMember, P2DModelInterface, java.io.Serializable, java.awt.datatransfer.Transferable

All Known Implementing Classes:

P2DPlotModel

public interface P2DPlotModelInterface
extends P2DModelInterface

The P2DPlotModelInterface defines the plot model behaviour.

Since:

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

Version:

$Revision: 1.11 $

Author:

Andreas Hofmann

Field Summary

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

Method Summary

Methods

Modifier and Type	Method and Description
P2DChannelInterface[]	addChannelComponent(P2DComponentInterface component, java.lang.String yName) Add a channel component to the plot model.
P2DChannelInterface[]	addChannelComponent(P2DComponentInterface component, java.lang.String xName, java.lang.String yName) Add a channel component to the plot model.
void	clearChannelComponents(P2DComponentInterface component) Clear all channel components.
P2DAxisInterface[]	getAllYAxisComponents(P2DComponentInterface component) Retrieve all y-axis component.
P2DChannelInterface	getChannelComponent(P2DComponentInterface component) Retrieve the channel component.
P2DChannelInterface	getChannelComponent(P2DComponentInterface component, java.lang.String yName) Retrieve the channel component.
P2DChannelInterface[]	getChannelComponents(P2DComponentInterface component) Retrieve all channel components.
boolean	getHorizontalTile(P2DComponentInterface component) Get the horizontal tile flag.
P2DLegendInterface	getLegendComponent(P2DComponentInterface component) Retrieves the P2D legend component.
boolean	getLegendEnabled(P2DComponentInterface component) Get the boolean whether the legend is enabled.
P2DMarkerInterface	getMarkerComponent(P2DComponentInterface component) Get the marker component.
boolean	getSingleScale(P2DComponentInterface component) Get a boolean that indicates a single y scaling.
P2DTextInterface	getTitleComponent(P2DComponentInterface component) Retrieves the P2D text component used as title.
boolean	getVerticalTile(P2DComponentInterface component) Get the vertical tile flag.
P2DAxisInterface	getXAxisComponent(P2DComponentInterface component) Retrieve the x-axis component.
java.lang.String	getXChannelName(P2DComponentInterface component) Get the name of the x Channel.
P2DAxisInterface	getYAxisComponent(P2DComponentInterface component) Retrieve the y-axis component.
P2DAxisInterface	getYAxisComponent(P2DComponentInterface component, java.lang.String yName) Retrieve the y-axis component.
boolean	hasChannels(P2DComponentInterface component) Return a boolean whether the plot contains channels.
P2DChannelInterface[]	setChannelComponent(P2DComponentInterface component, java.lang.String yName) Set the channel component.
P2DChannelInterface[]	setChannelComponent(P2DComponentInterface component, java.lang.String xName, java.lang.String yName) Set the channel component.
void	setHorizontalTile(P2DComponentInterface component, boolean flag) Set the horizontal tile flag.
P2DLegendInterface	setLegendComponent(P2DComponentInterface component, P2DLegendInterface legend) Set the legend of the plot.
void	setLegendEnabled(P2DComponentInterface component, boolean flag) Enable the legend.
void	setSingleScale(P2DComponentInterface component, boolean flag) Set a boolean for signle scaling.
P2DTextInterface	setTitleComponent(P2DComponentInterface component, FwkArrayInterface arr) Set the title of the plot.
P2DTextInterface	setTitleComponent(P2DComponentInterface component, P2DTextInterface text) Set the title of the plot.
P2DTextInterface	setTitleComponent(P2DComponentInterface component, java.lang.String title) Set the title of the plot.
void	setVerticalTile(P2DComponentInterface component, boolean flag) Set the vertical tile flag.
void	setXChannelName(P2DComponentInterface component, java.lang.String xName) Set the name of the x Channel.

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

addDialogPane, boundsAcceptable, calculateBoundingBoxRelativeTo, configure, containsAllChildren, containsAllChildren, frameHasHandles, getActive, getActiveHandle, getAllArmedComponents, getAllArmedComponents, getAppearance, getBackground, getBackgroundColor, getBackgroundTransparency, getBackgroundVisible, getBoundingBox, getChild, getChild, getCommands, getContainerMap, getDecorated, getDialogPane, getDialogPanes, getDialogPaneValue, getDialogPaneValues, getFrame, getFrameColor, getFrameHandlesVisible, getFrameLinesVisible, getFrameTransparency, getFrameVisible, getHeight, getRatioFix, getShortName, getTransform, getWidth, hasActiveChild, initialize, install, isInside, isInside, isInternalMouseListenerActive, registerContainer, removeDialogPane, resetActiveHandle, revalidate, scaleStroke, scaleStroke, setActive, setActiveHandle, setAppearance, setBackgroundColor, setBackgroundTransparency, setBackgroundVisible, setBoundingBox, setContainerMap, setDecorated, setDialogPaneValues, setFrameColor, setFrameHandlesVisible, setFrameLinesVisible, setFrameTransparency, setFrameVisible, setInternalMouseListenerActive, setRatioFix, setTransform, transformPoint, transformPoint, uninstall, unregisterContainer

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

Method Detail

setTitleComponent

P2DTextInterface setTitleComponent(P2DComponentInterface component,
                                 java.lang.String title)

Set the title of the plot.

Parameters:

title - The title string.

setTitleComponent

P2DTextInterface setTitleComponent(P2DComponentInterface component,
                                 FwkArrayInterface arr)

Set the title of the plot.

Parameters:

arr - an array containing the title stings.

setTitleComponent

P2DTextInterface setTitleComponent(P2DComponentInterface component,
                                 P2DTextInterface text)

Set the title of the plot.

Parameters:

text - The P2D text component used as title.

getTitleComponent

P2DTextInterface getTitleComponent(P2DComponentInterface component)

Retrieves the P2D text component used as title.

Returns:

The P2D text component used as title.

setLegendComponent

P2DLegendInterface setLegendComponent(P2DComponentInterface component,
                                    P2DLegendInterface legend)

Set the legend of the plot.

Parameters:

legend - The P2D legend component.

getLegendComponent

P2DLegendInterface getLegendComponent(P2DComponentInterface component)

Retrieves the P2D legend component.

Returns:

The P2D legend component.

clearChannelComponents

void clearChannelComponents(P2DComponentInterface component)

Clear all channel components.

addChannelComponent

P2DChannelInterface[] addChannelComponent(P2DComponentInterface component,
                                        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(P2DComponentInterface component,
                                        java.lang.String yName)

Add a channel component to the plot model.

Parameters:

yName - The name of the channel to be added.

setChannelComponent

P2DChannelInterface[] setChannelComponent(P2DComponentInterface component,
                                        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(P2DComponentInterface component,
                                        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.

hasChannels

boolean hasChannels(P2DComponentInterface component)

Return a boolean whether the plot contains channels.

Returns:

true if the plot has any channel.

getChannelComponent

P2DChannelInterface getChannelComponent(P2DComponentInterface component)

Retrieve the channel component.

Returns:

the channel component of the plot.

getChannelComponents

P2DChannelInterface[] getChannelComponents(P2DComponentInterface component)

Retrieve all channel components.

Returns:

all known channels.

getChannelComponent

P2DChannelInterface getChannelComponent(P2DComponentInterface component,
                                      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(P2DComponentInterface component)

Retrieve the x-axis component.

Returns:

the x-axis component of the plot.

getYAxisComponent

P2DAxisInterface getYAxisComponent(P2DComponentInterface component)

Retrieve the y-axis component.

Returns:

the y-axis component of the plot.

getYAxisComponent

P2DAxisInterface getYAxisComponent(P2DComponentInterface component,
                                 java.lang.String yName)

Retrieve the y-axis component.

Parameters:

yName - The name channel for that the axis should be returned.

Returns:

the y-axis component of the plot.

getAllYAxisComponents

P2DAxisInterface[] getAllYAxisComponents(P2DComponentInterface component)

Retrieve all y-axis component.

Returns:

the y-axis components of the plot.

getMarkerComponent

P2DMarkerInterface getMarkerComponent(P2DComponentInterface component)

Get the marker component.

Returns:

The marker component.

setXChannelName

void setXChannelName(P2DComponentInterface component,
                   java.lang.String xName)

Set the name of the x Channel.

Parameters:

xName - the name of the x channel.

getXChannelName

java.lang.String getXChannelName(P2DComponentInterface component)

Get the name of the x Channel.

Returns:

the name of the x channel.

getHorizontalTile

boolean getHorizontalTile(P2DComponentInterface component)

Get the horizontal tile flag.

Returns:

if the multiple channels are horizontal tiled.

setHorizontalTile

void setHorizontalTile(P2DComponentInterface component,
                     boolean flag)

Set the horizontal tile flag.

Parameters:

flag - if the multiple channels are horizontal tiled.

getSingleScale

boolean getSingleScale(P2DComponentInterface component)

Get a boolean that indicates a single y scaling.

Returns:

if if there is one y-axis only.

setSingleScale

void setSingleScale(P2DComponentInterface component,
                  boolean flag)

Set a boolean for signle scaling.

Parameters:

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

getVerticalTile

boolean getVerticalTile(P2DComponentInterface component)

Get the vertical tile flag.

Returns:

if the multiple channels are vertical tiled.

setVerticalTile

void setVerticalTile(P2DComponentInterface component,
                   boolean flag)

Set the vertical tile flag.

Parameters:

flag - if the multiple channels are vertical tiled.

setLegendEnabled

void setLegendEnabled(P2DComponentInterface component,
                    boolean flag)

Enable the legend.

Parameters:

flag - if true the legend is enabled.

getLegendEnabled

boolean getLegendEnabled(P2DComponentInterface component)

Get the boolean whether the legend is enabled.

Returns:

true if the legend is enabled.