com.highqsoft.interfaces.p2d

Interface P2DLegendModelInterface

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:

P2DLegendModel

public interface P2DLegendModelInterface
extends P2DModelInterface

The P2DLegendModelInterface defines the legend model behaviour.

Since:

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

Version:

$Revision: 1.10 $

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(P2DLegendInterface component, P2DChannelInterface channel) Add a channel component to the legend.
void	addChannel(P2DLegendInterface component, java.lang.String name) Add a channel component to the legend.
float	getAlignment(P2DLegendInterface component) Get the alignment value.
FwkArrayInterface	getAttributedText(P2DLegendInterface component) Get the attributed string of the text.
P2DAttributorInterface	getAttributor(P2DLegendInterface component) Get the title attributor.
java.lang.String[]	getChannelNames(P2DLegendInterface component) Get an array containing all the names.
P2DChannelInterface[]	getChannels(P2DLegendInterface component) Get an array containing all channels.
void	removeAllChannels(P2DLegendInterface component) Remove all channel components from the legend.
void	removeChannel(P2DLegendInterface component, P2DChannelInterface channel) Remove a channel component from the legend.
void	removeChannel(P2DLegendInterface component, java.lang.String name) Remove a channel component from the legend.
void	setAlignment(P2DLegendInterface component, float ali) Set the alignment of the text.
void	setAttributor(P2DLegendInterface component, P2DAttributorInterface attributor) Set the title attributor.

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

addChannel

void addChannel(P2DLegendInterface component,
              java.lang.String name)

Add a channel component to the legend.

Parameters:

component - The legend component to that the model belongs.

name - The name of the channel component to be added.

addChannel

void addChannel(P2DLegendInterface component,
              P2DChannelInterface channel)

Add a channel component to the legend.

Parameters:

component - The legend component to that the model belongs.

channel - The the channel component to be added.

removeAllChannels

void removeAllChannels(P2DLegendInterface component)

Remove all channel components from the legend.

Parameters:

component - The legend component to that the model belongs.

name - the name of the channel component to be removed.

removeChannel

void removeChannel(P2DLegendInterface component,
                 java.lang.String name)

Remove a channel component from the legend.

Parameters:

component - The legend component to that the model belongs.

name - the name of the channel component to be removed.

removeChannel

void removeChannel(P2DLegendInterface component,
                 P2DChannelInterface channel)

Remove a channel component from the legend.

Parameters:

component - The legend component to that the model belongs.

channel - the channel component to be removed.

getChannelNames

java.lang.String[] getChannelNames(P2DLegendInterface component)

Get an array containing all the names.

Returns:

the array containing all channel names.

getChannels

P2DChannelInterface[] getChannels(P2DLegendInterface component)

Get an array containing all channels.

Returns:

the array containing all channels.

setAttributor

void setAttributor(P2DLegendInterface component,
                 P2DAttributorInterface attributor)

Set the title attributor.

Parameters:

attributor - The title attributor

getAttributor

P2DAttributorInterface getAttributor(P2DLegendInterface component)

Get the title attributor.

Returns:

The title attributor

getAttributedText

FwkArrayInterface getAttributedText(P2DLegendInterface component)

Get the attributed string of the text.

Returns:

An array containing the attributed text value.

setAlignment

void setAlignment(P2DLegendInterface component,
                float ali)

Set the alignment of the text.

Parameters:

ali - The alignment value. 0 mean left and 1 is rigth aligned,

getAlignment

float getAlignment(P2DLegendInterface component)

Get the alignment value. The method return predefined values only.

Returns:

the alignment value.