com.highqsoft.interfaces.p2d

Interface P2DChannelInterface

All Superinterfaces:

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

All Known Implementing Classes:

P2DChannel

public interface P2DChannelInterface
extends P2DComponentInterface, javax.infobus.DataItemChangeListener, P2DScalableInterface

The P2DChannelInterface describes the functionality of a P2D package text component.

Since:

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

Version:

$Revision: 1.12 $

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
boolean	getEnvelope() Get the flag that controls the channel to draw all points (no envelope).
boolean	getEnvelopeMaxLineVisible() Get the envelope maximum line visible flag.
boolean	getEnvelopeMeanLineVisible() Get the mean line visible flag.
boolean	getEnvelopeMinLineVisible() Get the envelope minimum line visible flag.
long	getMaxCount() Retrieves highest value of the three column data counts.
double	getMaxXStepSize() Get the maximum step size.
long	getMinCount() Retrieves lowest value of the three column data counts.
P2DPointInterface	getPointAt(int index) Get the point at the specified index.
P2DRange2DInterface	getRange() Get the range of the channel.
java.awt.Stroke	getShapeStroke() Get the stroke used parallel to the dotjoin stroke.
P2DAxisInterface	getXAxis() Retrieve the x-axis.
java.lang.String	getXAxisName() Get the name of the x-axis.
FwkColumnAccessInterface	getXColumn() The the x column that belongs to that channel.
java.lang.String	getXDataItemName() Get the name of the X DataItem.
P2DRange1DInterface	getXRange() Get the x range of the channel.
P2DAxisInterface	getYAxis() Retrieve the y-axis.
java.lang.String	getYAxisName() Get the name of the y-axis.
FwkColumnAccessInterface	getYColumn() The the y column that belongs to that channel.
java.lang.String	getYDataItemName() Get the name of the y DataItem.
P2DRange1DInterface	getYRange() Get the y range of the channel.
void	setEnvelope(boolean flag) Configure the channel to draw all points (no envelope).
void	setEnvelopeMaxLineVisible(boolean flag) Set the envelope maximum line visible.
void	setEnvelopeMeanLineVisible(boolean flag) Set the mean line visible.
void	setEnvelopeMinLineVisible(boolean flag) Set the envelope minimum line visible.
void	setMaxXStepSize(double maxStepSize) If this channel defines a continuous x data channel, that has steps, the normal drawing behavior is to draw a line from the end to the beginning of the next measuring point.
void	setShapeStroke(java.awt.Stroke stroke) Set the additional stroke for the shape.
void	setXAxisName(java.lang.String axisName) Set the name of the x-axis.
void	setXDataItemName(java.lang.String dataItemName) Set the name of the x DataItem.
void	setYAxisName(java.lang.String axisName) Set the name of the y-axis.
void	setYDataItemName(java.lang.String dataItemName) Set the name of the y DataItem.

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

Methods inherited from interface javax.infobus.DataItemChangeListener

dataItemAdded, dataItemDeleted, dataItemRevoked, dataItemValueChanged, rowsetCursorMoved

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

initializeAxis

Method Detail

getRange

P2DRange2DInterface getRange()

Get the range of the channel.

Returns:

The range of the channel.

getXRange

P2DRange1DInterface getXRange()

Get the x range of the channel.

Returns:

The x range of the channel.

getYRange

P2DRange1DInterface getYRange()

Get the y range of the channel.

Returns:

The y range of the channel.

getMinCount

long getMinCount()

Retrieves lowest value of the three column data counts.

Returns:

The lowest value count.

getMaxCount

long getMaxCount()

Retrieves highest value of the three column data counts.

Returns:

The highest value count.

setXAxisName

void setXAxisName(java.lang.String axisName)

Set the name of the x-axis. This routine fires a PropertyChangeEvent on propterty XAxis.

Parameters:

axisName - The new x-axis name.

getXAxisName

java.lang.String getXAxisName()

Get the name of the x-axis. This method return null, if there isn't a axis available.

Returns:

The current name of the x-axis.

getXAxis

P2DAxisInterface getXAxis()

Retrieve the x-axis.

Returns:

The x-axis object.

setYAxisName

void setYAxisName(java.lang.String axisName)

Set the name of the y-axis. This routine fires a PropertyChangeEvent on propterty YAxis.

Parameters:

axisName - The new y-axis name.

getYAxisName

java.lang.String getYAxisName()

Get the name of the y-axis. This method return null, if there isn't a axis available.

Returns:

The current name of the y-axis.

getYAxis

P2DAxisInterface getYAxis()

Retrieve the y-axis.

Returns:

The y-axis object.

setXDataItemName

void setXDataItemName(java.lang.String dataItemName)

Set the name of the x DataItem. This name is used as a infobus membername. It must specify the item and the bus name in the following syntax:

itemName@infobusName

This routine fires a PropertyChangeEvent on propterty XDataItemName.

Parameters:

dataItemName - The new name of the x DataItem.

getXDataItemName

java.lang.String getXDataItemName()

Get the name of the X DataItem. This method return null, if there isn't an item available.

Returns:

The current name of the X DataItem.

setYDataItemName

void setYDataItemName(java.lang.String dataItemName)

Set the name of the y DataItem. This name is used as a infobus membername. It must specify the item and the bus name in the following syntax:

itemName@infobusName

This routine fires a PropertyChangeEvent on propterty YDataItemName.

Parameters:

dataItemName - The new name of the y DataItem.

getYDataItemName

java.lang.String getYDataItemName()

Get the name of the y DataItem. This method return null, if there isn't an item available.

Returns:

The current name of the y DataItem.

getPointAt

P2DPointInterface getPointAt(int index)

Get the point at the specified index.

Returns:

The poibnt at specified index.

getXColumn

FwkColumnAccessInterface getXColumn()

The the x column that belongs to that channel.

Returns:

The column

getYColumn

FwkColumnAccessInterface getYColumn()

The the y column that belongs to that channel.

Returns:

The column

setEnvelopeMeanLineVisible

void setEnvelopeMeanLineVisible(boolean flag)

Set the mean line visible.

Parameters:

flag - if true the mean line will be drawn.

getEnvelopeMeanLineVisible

boolean getEnvelopeMeanLineVisible()

Get the mean line visible flag.

Returns:

true if the mean line will be drawn.

setEnvelopeMaxLineVisible

void setEnvelopeMaxLineVisible(boolean flag)

Set the envelope maximum line visible. This flag is checked when the display resolution is lower the the data resolution.

Parameters:

flag - if true the envelope maximum line will be drawn.

getEnvelopeMaxLineVisible

boolean getEnvelopeMaxLineVisible()

Get the envelope maximum line visible flag. This flag is checked when the display resolution is lower the the data resolution.

Returns:

true if the envelope maximum line will be drawn.

setEnvelopeMinLineVisible

void setEnvelopeMinLineVisible(boolean flag)

Set the envelope minimum line visible. This flag is checked when the display resolution is lower the the data resolution.

Parameters:

flag - if true the envelope minimum line will be drawn.

getEnvelopeMinLineVisible

boolean getEnvelopeMinLineVisible()

Get the envelope minimum line visible flag. This flag is checked when the display resolution is lower the the data resolution.

Returns:

true if the envelope minimum line will be drawn.

setShapeStroke

void setShapeStroke(java.awt.Stroke stroke)

Set the additional stroke for the shape.

Parameters:

stroke - the additional stroke use parallel to the dotjoin stroke.

getShapeStroke

java.awt.Stroke getShapeStroke()

Get the stroke used parallel to the dotjoin stroke.

Returns:

The shape stroke.

setEnvelope

void setEnvelope(boolean flag)

Configure the channel to draw all points (no envelope). Per default an envelope will be determined, if the resolution of the destination is to low.

Parameters:

flag - if false the channel draws all the points.

getEnvelope

boolean getEnvelope()

Get the flag that controls the channel to draw all points (no envelope). Per default an envelope will be determined, if the resolution of the destination is to low.

Returns:

if false the channel draws all the points.

setMaxXStepSize

void setMaxXStepSize(double maxStepSize)

If this channel defines a continuous x data channel, that has steps, the normal drawing behavior is to draw a line from the end to the beginning of the next measuring point. An example is a time measurement with constant sample rate, but with interruptions. Stop after 3 three minutes and start again 2 minutes later. During the measurement the sample rate doesn't change. The section between should not be draw as line, because there are no valid points. Use this method to specify an interval that is used to omit greater time steps. If you use a constants sample rate the following value may be a good choice: maxStepSize = getRange()/nPoints

Parameters:

maxStepSize - the maximum step size that is concatenated by line in plot.

getMaxXStepSize

double getMaxXStepSize()

Get the maximum step size.

Returns:

the maximum step size that is concatenated by line in plot.

See Also:

setMaxXStepSize(double)