com.highqsoft.interfaces.p2d

Interface P2DAxisInterface

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, P2DAutoRangeInterface, P2DComponentControlInterface, P2DComponentInterface, P2DComponentModelInterface, P2DComponentViewInterface, P2DContainerInterface, P2DRangeInterface, java.io.Serializable, java.awt.datatransfer.Transferable

All Known Implementing Classes:

P2DAxis

public interface P2DAxisInterface
extends P2DComponentInterface, P2DAutoRangeInterface

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

Since:

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

Version:

$Revision: 1.13 $

Author:

Andreas Hofmann

Field Summary

Fields

Modifier and Type	Field and Description
static java.awt.BasicStroke	DASH_GRID The DASH grid stroke.
static java.awt.BasicStroke	DOT_DASH_GRID The DOT DASH grid stroke.
static java.awt.BasicStroke	DOT_DOT_DASH_GRID The DOT DOT DASH grid stroke.
static java.awt.BasicStroke	DOT_GRID The DOT grid stroke.

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
void	addChannel(P2DChannelInterface channel) Add the channel to the observer list of the axis.
void	drawGrid(java.awt.Graphics2D g, P2DRange1DInterface range) Draw the grid of the axis.
FwkArrayInterface	getAttributedTickvalues() Get the nicenumber vector of strings from axis.
FwkArrayInterface	getAttributedTitle() Get the attributed title string of the axis.
boolean	getAutoRange() Get the auto-range flag of the axis.
double	getBase() Get the base of the nice number calculation.
P2DRange1DInterface	getChannelRange() Get the channel range of the axis.
java.util.Iterator	getChannels() Get the list of channels.
boolean	getGrid() Get the grid state.
FwkAppearanceInterface	getGridAppearance() Get the grid appearance.
java.awt.Color	getGridColor() Get the grid color.
float	getGridTransparency() Get the grid color transparency.
boolean	getLog() Return a boolean whether the axis is a logarithmn type.
boolean	getMinorTicks() Get the minor ticks state.
P2DRange1DInterface	getNiceNumberCalculator() Returns the nicenumber creator.
P2DRange1DInterface	getNiceNumberRange() Get the range of the nice numbers.
double	getPosition() Get the position of the axis.
P2DRange1DInterface	getRange() Returns the effective range of the axis.
int	getTickCount() Get the total number of ticks.
double	getTicklen() Get the length of the ticks.
P2DAttributorInterface	getTickvalueAttributor() Get the attributer for the tickvalues.
FwkArrayInterface	getTickvalues() Get the nicenumber array.
java.lang.String	getTitle() Get the title string of the axis.
double	getTitleAlignment() Retrieve the title alignment of the axis.
P2DAttributorInterface	getTitleAttributor() Get the title attributer.
P2DAxisTypeInterface	getType() Get the type of the axis.
boolean	isValid() Returns a flag that indicates whether the view is currently valid.
void	nextRangeStep() Set the range to the next range step.
void	nextRangeWindow() Set the range to the next range window.
void	prevRangeStep() Set the range to the prev range step.
void	prevRangeWindow() Set the range to the prev range window.
void	removeChannel(P2DChannelInterface channel) Remove a channel from the observer list of the axis.
void	setAutoRange(boolean flag) Sets the auto-range flag of the axis.
void	setBase(double base) Set the base of the nice number calculation.
void	setFullResolution(P2DContainerInterface container) Set the range so that the full resolution is used for display.
void	setGrid(boolean flag) Turn on/off the grid.
void	setGridAppearance(FwkAppearanceInterface appearance) Set the grid appearance.
void	setGridColor(java.awt.Color color) Set the grid color.
void	setGridTransparency(float transparency) Set the grid color transparency.
void	setLog(boolean flag) Set the logarithmn type of the axis.
void	setMinorTicks(boolean flag) Turn on/off the minor ticks.
void	setNiceNumberCalculator(P2DRange1DInterface calculator) Set the nicenumber creator.
void	setPosition(double newPosition) Set the position of the axis.
void	setRange(P2DRange1DInterface newRange) Sets the range of the axis.
void	setTickCount(int ticks) Set the total number of ticks.
void	setTicklen(double newTicklen) Set the length of the ticks.
void	setTickvalueAttributor(P2DAttributorInterface attributor) Set the attributer for the tickvalues.
void	setTitle(java.lang.String newTitle) Set the title string of the axis.
void	setTitleAlignment(double alignment) Set the title alignment of the axis.
void	setTitleAttributor(P2DAttributorInterface attributor) Set the title attributer.
void	setType(P2DAxisTypeInterface newType) Set the type of the axis.
void	toBeginOfRange() Set the upper range value to the begin of autorange value.
void	toEndOfRange() Set the lower range value to the end of autorange value.
void	zoomIn() Zoom into.
void	zoomOut() Zoom out.

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, 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 com.highqsoft.interfaces.p2d.P2DRangeInterface

getLowerLimit, getUpperLimit, setLowerLimit, setUpperLimit

Field Detail

DOT_GRID

static final java.awt.BasicStroke DOT_GRID

The DOT grid stroke.

DASH_GRID

static final java.awt.BasicStroke DASH_GRID

The DASH grid stroke.

DOT_DASH_GRID

static final java.awt.BasicStroke DOT_DASH_GRID

The DOT DASH grid stroke.

DOT_DOT_DASH_GRID

static final java.awt.BasicStroke DOT_DOT_DASH_GRID

The DOT DOT DASH grid stroke.

Method Detail

isValid

boolean isValid()

Returns a flag that indicates whether the view is currently valid.

getNiceNumberRange

P2DRange1DInterface getNiceNumberRange()

Get the range of the nice numbers.

Returns:

The nicenumber range of the axis.

getChannelRange

P2DRange1DInterface getChannelRange()

Get the channel range of the axis.

Returns:

The range of the axis.

getRange

P2DRange1DInterface getRange()

Returns the effective range of the axis. The range of an axis is a combination of the range produced by the nice number algorithmn and the real range of the axis. This method returns the widest range of this combination.

Specified by:

getRange in interface P2DRangeInterface

Returns:

A range object.

setRange

void setRange(P2DRange1DInterface newRange)

Sets the range of the axis. This routine fires a PropertyChangeEvent on propterty Range.

Specified by:

setRange in interface P2DRangeInterface

Parameters:

newRange - The range of the axis.

getAutoRange

boolean getAutoRange()

Get the auto-range flag of the axis.

Specified by:

getAutoRange in interface P2DAutoRangeInterface

Returns:

The auto range flag of the axis.

setAutoRange

void setAutoRange(boolean flag)

Sets the auto-range flag of the axis. This routine fires a PropertyChangeEvent on propterty AutoRange.

Specified by:

setAutoRange in interface P2DAutoRangeInterface

Parameters:

flag - The new auto-range flag of the axis.

getTitle

java.lang.String getTitle()

Get the title string of the axis.

Specified by:

getTitle in interface FwkDescriptionInterface

Returns:

The title string.

setTitle

void setTitle(java.lang.String newTitle)

Set the title string of the axis. This routine fires a PropertyChangeEvent on propterty Title.

Parameters:

newTitle - The new title string.

getAttributedTitle

FwkArrayInterface getAttributedTitle()

Get the attributed title string of the axis.

Returns:

The current axis attributed title string.

setTitleAttributor

void setTitleAttributor(P2DAttributorInterface attributor)

Set the title attributer. This routine fires a PropertyChangeEvent on propterty TitleAttributor.

Parameters:

attributor - The title attributer

getTitleAttributor

P2DAttributorInterface getTitleAttributor()

Get the title attributer.

Returns:

The title attributer

addChannel

void addChannel(P2DChannelInterface channel)

Add the channel to the observer list of the axis.

Parameters:

channel - The channel to be observed.

removeChannel

void removeChannel(P2DChannelInterface channel)

Remove a channel from the observer list of the axis.

Parameters:

channel - The channel to be observed.

getChannels

java.util.Iterator getChannels()

Get the list of channels.

Returns:

a list registered channels.

getPosition

double getPosition()

Get the position of the axis.

setPosition

void setPosition(double newPosition)

Set the position of the axis. This routine fires a PropertyChangeEvent with Position

Parameters:

newPosition - The new axis position.

getTickvalues

FwkArrayInterface getTickvalues()

Get the nicenumber array.

Returns:

an Vector containing the tickvalues.

getAttributedTickvalues

FwkArrayInterface getAttributedTickvalues()

Get the nicenumber vector of strings from axis.

Returns:

A vector contaiting the nicenumber values strings.

setTickvalueAttributor

void setTickvalueAttributor(P2DAttributorInterface attributor)

Set the attributer for the tickvalues. This routine fires a PropertyChangeEvent on propterty TickvalueAttributor.

Parameters:

attributor - The tick value attributor.

getTickvalueAttributor

P2DAttributorInterface getTickvalueAttributor()

Get the attributer for the tickvalues.

Parameters:

The - tick value attributor.

getTicklen

double getTicklen()

Get the length of the ticks. This value should be in the range of 0 ... 1.0

setTicklen

void setTicklen(double newTicklen)

Set the length of the ticks. This routine fires a PropertyChangeEvent on propterty Ticklen.

Parameters:

ticklen - This value should be in the range of 0 ... 1.0

getType

P2DAxisTypeInterface getType()

Get the type of the axis.

setType

void setType(P2DAxisTypeInterface newType)

Set the type of the axis. This routine fires a PropertyChangeEvent on propterty Type.

Parameters:

The - new axis type. Use the predefined constants declaired in the P2DAxisModelInterface.

getLog

boolean getLog()

Return a boolean whether the axis is a logarithmn type.

Returns:

true if axis is logarithmn.

setLog

void setLog(boolean flag)

Set the logarithmn type of the axis. This routine fires a PropertyChangeEvent on propterty Type.

Parameters:

flag - true if axis is logarithmn.

setBase

void setBase(double base)

Set the base of the nice number calculation.

Parameters:

base - The new base

getBase

double getBase()

Get the base of the nice number calculation.

Returns:

The base

setGrid

void setGrid(boolean flag)

Turn on/off the grid.

Parameters:

flag - if true the grid is turned on.

getGrid

boolean getGrid()

Get the grid state.

Returns:

if true the grid is on.

setGridAppearance

void setGridAppearance(FwkAppearanceInterface appearance)

Set the grid appearance.

Parameters:

appearance - The grid appearance.

getGridAppearance

FwkAppearanceInterface getGridAppearance()

Get the grid appearance.

Returns:

the grid appearance.

setGridColor

void setGridColor(java.awt.Color color)

Set the grid color.

Parameters:

color - the color for the grid.

getGridColor

java.awt.Color getGridColor()

Get the grid color.

Returns:

the color of the grid.

setGridTransparency

void setGridTransparency(float transparency)

Set the grid color transparency.

Parameters:

transparency - the color transparency for the grid.

getGridTransparency

float getGridTransparency()

Get the grid color transparency.

Returns:

the color transparency of the grid.

drawGrid

void drawGrid(java.awt.Graphics2D g,
            P2DRange1DInterface range)

Draw the grid of the axis.

Parameters:

g - The graphical context.

range - The range for the grid.

zoomIn

void zoomIn()

Zoom into.

zoomOut

void zoomOut()

Zoom out.

toEndOfRange

void toEndOfRange()

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

toBeginOfRange

void toBeginOfRange()

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

nextRangeWindow

void nextRangeWindow()

Set the range to the next range window.

prevRangeWindow

void prevRangeWindow()

Set the range to the prev range window.

nextRangeStep

void nextRangeStep()

Set the range to the next range step.

prevRangeStep

void prevRangeStep()

Set the range to the prev range step.

setFullResolution

void setFullResolution(P2DContainerInterface container)

Set the range so that the full resolution is used for display.

Parameters:

container - The container that set the transformation.

getTickCount

int getTickCount()

Get the total number of ticks.

Returns:

The total number of tick values.

setTickCount

void setTickCount(int ticks)

Set the total number of ticks.

Parameters:

count - The total number of ticks. Set it to 0 if you wants that the axis determines the number itself.

setNiceNumberCalculator

void setNiceNumberCalculator(P2DRange1DInterface calculator)

Set the nicenumber creator. This object will be called if the nicenumbers are requested.

Parameters:

calculator - The calculator.

getNiceNumberCalculator

P2DRange1DInterface getNiceNumberCalculator()

Returns the nicenumber creator.

Returns:

calculator The calculator.

setTitleAlignment

void setTitleAlignment(double alignment)

Set the title alignment of the axis.

Parameters:

alignment - the alignment (default is 0.5 / center)

getTitleAlignment

double getTitleAlignment()

Retrieve the title alignment of the axis.

Returns:

the alignment (default is 0.5 / center)

setMinorTicks

void setMinorTicks(boolean flag)

Turn on/off the minor ticks.

Parameters:

flag - if true the minor ticks is turned on.

getMinorTicks

boolean getMinorTicks()

Get the minor ticks state.

Returns:

if true the grid is on.