com.highqsoft.interfaces.p2d

Interface P2DAxisModelInterface

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:

P2DAxisModel

public interface P2DAxisModelInterface
extends P2DModelInterface

The P2DAxisModelInterface defines the axis model behaviour.

Since:

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

Version:

$Revision: 1.13 $

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

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

isValid

boolean isValid(P2DComponentInterface component)

Check if the tickvalues arte valid?

Parameters:

component - The component to that the model belongs.

Returns:

true if the tickvalues are valid.

getNiceNumberRange

P2DRange1DInterface getNiceNumberRange(P2DComponentInterface component)

Get the range of the nice numbers.

Parameters:

component - The component to that the model belongs.

Returns:

The nicenumber range of the axis.

getChannelRange

P2DRange1DInterface getChannelRange(P2DComponentInterface component)

Get the range of the axis.

Parameters:

component - The component to that the model belongs.

Returns:

The current range setting.

getTickvalues

FwkArrayInterface getTickvalues(P2DComponentInterface component)

Get the nicenumber vector of the axis ticks containing attributed strings.

Parameters:

component - The component to that the model belongs.

Returns:

A vector containing the nicenumber values.

getAttributedTickvalues

FwkArrayInterface getAttributedTickvalues(P2DComponentInterface component)

Get the nicenumber vector of the axis attributed tick value strings.

Parameters:

component - The component to that the model belongs.

Returns:

A vector contaiting the nicenumber values strings.

setTickvalueAttributor

void setTickvalueAttributor(P2DComponentInterface component,
                          P2DAttributorInterface attributor)

Set the attributer for the tickvalues.

Parameters:

component - The component to that the model belongs.

attributor - The tick value attributor.

getTickvalueAttributor

P2DAttributorInterface getTickvalueAttributor(P2DComponentInterface component)

Get the attributer for the tickvalues.

Parameters:

component - The component to that the model belongs.

The - tick value attributor.

getTicklen

double getTicklen(P2DComponentInterface component)

Get the length of the ticks.

Parameters:

component - The component to that the model belongs.

Returns:

The length of the ticks.

setTicklen

void setTicklen(P2DComponentInterface component,
              double ticklen)

Set the length of the ticks.

Parameters:

component - The component to that the model belongs.

ticklen - The new axis ticklen.

getType

P2DAxisTypeInterface getType(P2DComponentInterface component)

Get the type of the axis.

Parameters:

component - The component to that the model belongs.

Returns:

The current axis type.

setType

void setType(P2DComponentInterface component,
           P2DAxisTypeInterface type)

Set the type of the axis.

Parameters:

component - The component to that the model belongs.

type - The new axis type.

getTitle

java.lang.String getTitle(P2DComponentInterface component)

Get the title string of the axis.

Parameters:

component - The component to that the model belongs.

Returns:

The current axis title string.

setTitle

void setTitle(P2DComponentInterface component,
            java.lang.String title)

Set the title string of the axis.

Parameters:

component - The component to that the model belongs.

title - The new axis title string.

setTitleAlignment

void setTitleAlignment(P2DComponentInterface component,
                     double alignment)

Set the title alignment of the axis.

Parameters:

component - The component to that the model belongs.

alignment - the alignment (default is 0.5 / center)

getTitleAlignment

double getTitleAlignment(P2DComponentInterface component)

Retrieve the title alignment of the axis.

Parameters:

component - The component to that the model belongs.

Returns:

the alignment (default is 0.5 / center)

getAttributedTitle

FwkArrayInterface getAttributedTitle(P2DComponentInterface component)

Get the attributed title string of the axis.

Parameters:

component - The component to that the model belongs.

Returns:

The current axis attributed title string.

setTitleAttributor

void setTitleAttributor(P2DComponentInterface component,
                      P2DAttributorInterface attributor)

Set the title attributer.

Parameters:

component - The component to that the model belongs.

attributor - The title attributer

getTitleAttributor

P2DAttributorInterface getTitleAttributor(P2DComponentInterface component)

Get the title attributer.

Parameters:

component - The component to that the model belongs.

Returns:

The title attributer

addChannel

void addChannel(P2DComponentInterface component,
              P2DChannelInterface channel)

Add the channel to the observer list of the axis.

Parameters:

component - The component to that the model belongs.

channel - The channel to be observed.

removeChannel

void removeChannel(P2DComponentInterface component,
                 P2DChannelInterface channel)

Remove a channel from the observer list of the axis.

Parameters:

component - The component to that the model belongs.

channel - The channel to be observed.

getChannels

java.util.Iterator getChannels(P2DComponentInterface component)

Returns an iterator to registered channels.

Parameters:

component - The component to that the model belongs.

Returns:

The iterator.

getPosition

double getPosition(P2DComponentInterface component)

Get the position of the axis.

Parameters:

component - The component to that the model belongs.

Returns:

The position of the axis.

setPosition

void setPosition(P2DComponentInterface component,
               double newPosition)

Set the position of the axis.

Parameters:

component - The component to that the model belongs.

newPosition - The new axis position.

getLog

boolean getLog(P2DComponentInterface component)

Return a boolean whether the axis is a logarithmn type.

Parameters:

component - The component to that the model belongs.

Returns:

true if axis is logarithmn.

setLog

void setLog(P2DComponentInterface component,
          boolean flag)

Set the logarithmn type of the axis.

Parameters:

component - The component to that the model belongs.

flag - true if axis is logarithmn.

setBase

void setBase(P2DComponentInterface component,
           double base)

Set the base of the nice number calculation.

Parameters:

base - The new base

getBase

double getBase(P2DComponentInterface component)

Get the base of the nice number calculation.

Parameters:

component - The component to that the model belongs.

Returns:

The base

setGrid

void setGrid(P2DComponentInterface component,
           boolean flag)

Turn on/off the grid.

Parameters:

component - The component to that the model belongs.

flag - if true the grid is turned on.

getGrid

boolean getGrid(P2DComponentInterface component)

Get the grid state.

Parameters:

component - The component to that the model belongs.

Returns:

if true the grid is on.

setGridAppearance

void setGridAppearance(P2DComponentInterface component,
                     FwkAppearanceInterface appearance)

Set the grid appearance.

Parameters:

component - The component to that the model belongs.

appearance - The grid appearance.

getGridAppearance

FwkAppearanceInterface getGridAppearance(P2DComponentInterface component)

Get the grid appearance.

Parameters:

component - The component to that the model belongs.

Returns:

the grid appearance.

setGridColor

void setGridColor(P2DComponentInterface component,
                java.awt.Color color)

Set the grid color.

Parameters:

component - The component to that the model belongs.

color - the color for the grid.

getGridColor

java.awt.Color getGridColor(P2DComponentInterface component)

Get the grid color.

Parameters:

component - The component to that the model belongs.

Returns:

the color of the grid.

setGridTransparency

void setGridTransparency(P2DComponentInterface component,
                       float transparency)

Set the grid color transparency.

Parameters:

component - The component to that the model belongs.

transparency - the color transparency for the grid.

getGridTransparency

float getGridTransparency(P2DComponentInterface component)

Get the grid color transparency.

Parameters:

component - The component to that the model belongs.

Returns:

the color transparency of the grid.

getRange

P2DRange1DInterface getRange(P2DComponentInterface component)

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.

Parameters:

component - The component to that the model belongs.

Returns:

A range object.

setRange

void setRange(P2DComponentInterface component,
            P2DRange1DInterface range)

Set the Axis Range.

Parameters:

component - The component to that the model belongs.

Range1D - The new axis range.

getLowerLimit

double getLowerLimit(P2DComponentInterface component)

Returns the lower value of the range.

Parameters:

component - The component to that the model belongs.

Returns:

the lower value.

getMinPositiveValue

double getMinPositiveValue(P2DComponentInterface component)

Returns the minimal positive value.

Returns:

the value.

getUpperLimit

double getUpperLimit(P2DComponentInterface component)

Returns the upper value of the range.

Parameters:

component - The component to that the model belongs.

Returns:

the upper value.

setLowerLimit

void setLowerLimit(P2DComponentInterface component,
                 double lower)

Set the lower value of the range.

Parameters:

component - The component to that the model belongs.

lower - the lower value of the marker.

setUpperLimit

void setUpperLimit(P2DComponentInterface component,
                 double upper)

Set the upper value of the range.

Parameters:

component - The component to that the model belongs.

upper - the upper value of the marker.

getAutoRange

boolean getAutoRange(P2DComponentInterface component)

Get the auto-range flag of the axis.

Parameters:

component - The component to that the model belongs.

Returns:

The auto range flag of the axis.

setAutoRange

void setAutoRange(P2DComponentInterface component,
                boolean flag)

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

Parameters:

component - The component to that the model belongs.

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

zoomIn

void zoomIn(P2DComponentInterface component)

Zoom into.

Parameters:

component - The component to that the model belongs.

zoomOut

void zoomOut(P2DComponentInterface component)

Zoom out.

Parameters:

component - The component to that the model belongs.

toEndOfRange

void toEndOfRange(P2DComponentInterface component)

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

Parameters:

component - The component to that the model belongs.

toBeginOfRange

void toBeginOfRange(P2DComponentInterface component)

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

Parameters:

component - The component to that the model belongs.

nextRangeWindow

void nextRangeWindow(P2DComponentInterface component)

Set the range to the next range window.

Parameters:

component - The component to that the model belongs.

prevRangeWindow

void prevRangeWindow(P2DComponentInterface component)

Set the range to the prev range window.

Parameters:

component - The component to that the model belongs.

nextRangeStep

void nextRangeStep(P2DComponentInterface component)

Set the range to the next range step.

Parameters:

component - The component to that the model belongs.

prevRangeStep

void prevRangeStep(P2DComponentInterface component)

Set the range to the prev range step.

Parameters:

component - The component to that the model belongs.

setFullResolution

void setFullResolution(P2DComponentInterface component,
                     P2DContainerInterface container)

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

Parameters:

component - The component to that the model belongs.

getTickCount

int getTickCount(P2DComponentInterface component)

Get the total number of ticks.

Parameters:

component - The component to that the model belongs.

Returns:

The total number of tick values.

setTickCount

void setTickCount(P2DComponentInterface component,
                int ticks)

Set the total number of ticks.

Parameters:

component - The component to that the model belongs.

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

setNiceNumberCalculator

void setNiceNumberCalculator(P2DComponentInterface component,
                           P2DRange1DInterface calculator)

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

Parameters:

component - The component to that the model belongs.

calculator - The calculator.

getNiceNumberCalculator

P2DRange1DInterface getNiceNumberCalculator(P2DComponentInterface component)

Returns the nicenumber creator.

Parameters:

component - The component to that the model belongs.

Returns:

calculator The calculator.

setMinorTicks

void setMinorTicks(P2DComponentInterface component,
                 boolean flag)

Turn on/off the minor ticks.

Parameters:

component - The component to that the model belongs.

flag - if true the minor ticks is turned on.

getMinorTicks

boolean getMinorTicks(P2DComponentInterface component)

Get the minor ticks state.

Parameters:

component - The component to that the model belongs.

Returns:

if true the grid is on.