com.highqsoft.p2d

Class P2DLegendModel

java.lang.Object

com.highqsoft.fwk.Fwk

com.highqsoft.fwk.FwkDescription

com.highqsoft.fwk.FwkPropertyChange

com.highqsoft.fwk.FwkPersistence

com.highqsoft.fwk.FwkItem

com.highqsoft.fwk.FwkInfoBusMember

com.highqsoft.p2d.P2DComponentModel

com.highqsoft.p2d.P2DLegendModel

All Implemented Interfaces:

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

public class P2DLegendModel
extends P2DComponentModel
implements P2DLegendModelInterface, FwkPropertyChangeListenerInterface

The P2DLegendModel object holds the model of an legend group.

Since:

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

Version:

$Revision: 1.12 $

Author:

Andreas Hofmann

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected float	alignment The alignment value.
protected P2DAttributorInterface	attributor The attributor.
protected static int	INCREMENT
static java.lang.String	version

Fields inherited from class com.highqsoft.p2d.P2DComponentModel

appearance, background, BACKGROUND_COLOR_IDENT, BACKGROUND_COLOR_TEXT_KEY, BACKGROUND_COLOR_TOOLTIP_KEY, BACKGROUND_VISIBLE_TEXT_KEY, boundingBox, COLOR_IDENT, COLOR_TEXT_KEY, COLOR_TOOLTIP_KEY, containerMap, decorated, FONT_IDENT, FONT_TEXT_KEY, FONT_TOOLTIP_KEY, frame, FRAME_COLOR_IDENT, FRAME_COLOR_TEXT_KEY, FRAME_COLOR_TOOLTIP_KEY, internalMouseListenerActive, PROPERTIES_TEXT_KEY, ratioFix, staticPanes, VISIBLE_TEXT_KEY

Fields inherited from class com.highqsoft.fwk.FwkInfoBusMember

infoBusMemberSupport

Fields inherited from class com.highqsoft.fwk.FwkItem

changeManager, properties, suspendChangeManager

Fields inherited from class com.highqsoft.fwk.FwkPropertyChange

source

Fields inherited from class com.highqsoft.fwk.FwkDescription

author, buildnr, className, company, copyright, creationDate, dateFormatString, description, eMail, FWK_ICON, FWK_ICON_ARRAY, FWK_ICON_BG, FWK_ICON_BG_ARRAY, FWK_ICON_BG_LARGE, FWK_ICON_BG_LARGE_ARRAY, FWK_ICON_LARGE, FWK_ICON_LARGE_ARRAY, icon, ICON, iconCount, iconKey, internetAddress, name, titleName

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

Constructor Summary

Constructors

Constructor and Description
P2DLegendModel()

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.
protected void	addName(java.lang.String name) Add the given name to the array.
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	initialize() Initialize
void	propertyChange(java.beans.PropertyChangeEvent ev) The property change listener.
void	removeAllChannels(P2DLegendInterface component) Remove all channel components from the legend.
protected void	removeAllNames(P2DLegendInterface component) Remove all names from the array.
void	removeChannel(P2DLegendInterface component, P2DChannelInterface channel) Remove a channel component to the legend.
void	removeChannel(P2DLegendInterface component, java.lang.String name) Remove a channel component to the legend.
protected void	removeName(java.lang.String name) Remove the given name from the array.
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 class com.highqsoft.p2d.P2DComponentModel

addDialogPane, boundsAcceptable, calculateBoundingBoxRelativeTo, closestIntersection, configure, contains, contains, containsAllChildren, containsAllChildren, createDialogPanes, frameHasHandles, getActive, getActiveHandle, getAllArmedComponents, getAllArmedComponents, getAppearance, getArea, getBackground, getBackgroundColor, getBackgroundTransparency, getBackgroundVisible, getBoundingBox, getChild, getChild, getClip, getColor, getCommands, getContainerMap, getDashArray, getDashPhase, getDecorated, getDialogPane, getDialogPanes, getDialogPaneValue, getDialogPaneValues, getEndCap, getFill, getFont, getFrame, getFrameColor, getFrameHandlesVisible, getFrameLinesVisible, getFrameTransparency, getFrameVisible, getHeight, getInverseTransform, getLineJoin, getLineWidth, getLower, getLower, getMiterLimit, getRatioFix, getRectangle, getScaledHeight, getScaledLower, getScaledLower, getScaledUpper, getScaledUpper, getScaledWidth, getShortName, getStroke, getTransform, getTransform, getTranslation, getTransparency, getUpper, getUpper, getVersion, getVisible, getWidth, getXFactor, getXOffset, getYFactor, getYOffset, hasActiveChild, install, intersects, intersects, intersects, intersects, inverseTransformPoint, isInside, isInside, isInside, isInternalMouseListenerActive, isVisible, move, registerContainer, release, release, removeDialogPane, resetActiveHandle, revalidate, scaleStroke, scaleStroke, setActive, setActiveHandle, setAppearance, setBackgroundColor, setBackgroundTransparency, setBackgroundVisible, setBoundingBox, setClip, setClip, setColor, setContainerMap, setDashArray, setDashPhase, setDecorated, setDialogPaneValues, setEndCap, setFill, setFont, setFrameColor, setFrameHandlesVisible, setFrameLinesVisible, setFrameTransparency, setFrameVisible, setHeight, setInternalMouseListenerActive, setLineJoin, setLineWidth, setLower, setMiterLimit, setOffset, setRatioFix, setScale, setStroke, setTransform, setTransform, setTranslation, setTransparency, setUpper, setVisible, setWidth, setXScale, setYScale, transformPoint, transformPoint, uninstall, unregisterContainer

Methods inherited from class com.highqsoft.fwk.FwkInfoBusMember

addInfoBusPropertyListener, addInfoBusVetoableListener, finalize, getInfoBus, getInfoBusName, getMemberName, isConnected, joinInfoBus, removeInfoBusPropertyListener, removeInfoBusVetoableListener, setInfoBus, setInfoBusName, setMemberName, setName

Methods inherited from class com.highqsoft.fwk.FwkItem

addDataItemChangeListener, fireItemAdded, fireItemDeleted, fireItemRevoked, fireItemValueChanged, getName, getProperty, getPropertyGroup, getSource, isChangeManagerSuspended, removeDataItemChangeListener, setProperty, setPropertyGroup, suspendChangeManager

Methods inherited from class com.highqsoft.fwk.FwkPersistence

addCommand, addCommand, addToGroup, addToGroup, addVetoableChangeListener, addVetoableChangeListener, clearCommands, commandsAvailable, compareTo, deleteGroup, destroyController, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, getAuthor, getBuild, getCommand, getCommands, getCommands, getCompany, getCompanyInternetAddress, getCopyright, getCreationDate, getCreationDate, getDateFormatString, getDescription, getFwkMimeTypes, getGroup, getIcon, getIcon, getIconKey, getIconKey, getPersistentObjectNames, getSupportEMail, getTitle, getTitleName, getVetoableChangeArray, getVetoableChangeListenerArray, getVetoableChangeListenerArray, groupExists, removeCommand, removeFromGroup, removeVetoableChangeListener, removeVetoableChangeListener, setAuthor, setBuild, setCommands, setCompany, setCompanyInternetAddress, setCopyright, setCreationDate, setDateFormatString, setDescription, setDescriptor, setDescriptor, setIcon, setIcon, setIconKey, setIconKey, setSource, setSupportEMail, setTitleName

Methods inherited from class com.highqsoft.fwk.FwkPropertyChange

addPropertyChangeListener, addPropertyChangeListener, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getPropertyChangeArray, getPropertyChangeListenerArray, getPropertyChangeListenerArray, isPropertyChangeEventSuspended, removePropertyChangeListener, removePropertyChangeListener, suspendPropertyChangeEvents

Methods inherited from class com.highqsoft.fwk.FwkDescription

getClassName, getPresentationString, getPresentationString, getTransferData, getTransferDataFlavors, isDataFlavorSupported, lostOwnership, setClassName, setCreationDate, toString

Methods inherited from class com.highqsoft.fwk.Fwk

getNiceVersion

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

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, 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

Field Detail

version

public static final java.lang.String version

See Also:

Constant Field Values

INCREMENT

protected static final int INCREMENT

See Also:

Constant Field Values

attributor

protected P2DAttributorInterface attributor

The attributor.

alignment

protected float alignment

The alignment value.

Constructor Detail

P2DLegendModel

public P2DLegendModel()

Method Detail

initialize

public void initialize()

Initialize

Specified by:

initialize in interface P2DModelInterface

Overrides:

initialize in class P2DComponentModel

See Also:

P2DComponentModel.initialize

addName

protected void addName(java.lang.String name)

Add the given name to the array.

Parameters:

name - the name to be added.

removeName

protected void removeName(java.lang.String name)

Remove the given name from the array.

Parameters:

name - the name to be removed.

removeAllNames

protected void removeAllNames(P2DLegendInterface component)

Remove all names from the array.

addChannel

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

Add a channel component to the legend.

Specified by:

addChannel in interface P2DLegendModelInterface

Parameters:

component - The legend component to that the model belongs.

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

addChannel

public void addChannel(P2DLegendInterface component,
              P2DChannelInterface channel)

Add a channel component to the legend.

Specified by:

addChannel in interface P2DLegendModelInterface

Parameters:

component - The legend component to that the model belongs.

channel - The the channel component to be added.

removeAllChannels

public void removeAllChannels(P2DLegendInterface component)

Remove all channel components from the legend.

Specified by:

removeAllChannels in interface P2DLegendModelInterface

Parameters:

component - The legend component to that the model belongs.

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

removeChannel

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

Remove a channel component to the legend.

Specified by:

removeChannel in interface P2DLegendModelInterface

Parameters:

component - The legend component to that the model belongs.

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

removeChannel

public void removeChannel(P2DLegendInterface component,
                 P2DChannelInterface channel)

Remove a channel component to the legend.

Specified by:

removeChannel in interface P2DLegendModelInterface

Parameters:

component - The legend component to that the model belongs.

channel - the channel component to be removed.

getChannelNames

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

Get an array containing all the names.

Specified by:

getChannelNames in interface P2DLegendModelInterface

Returns:

the array containing all channel names.

getChannels

public P2DChannelInterface[] getChannels(P2DLegendInterface component)

Get an array containing all channels.

Specified by:

getChannels in interface P2DLegendModelInterface

Returns:

the array containing all channels.

setAttributor

public void setAttributor(P2DLegendInterface component,
                 P2DAttributorInterface attributor)

Set the title attributor.

Specified by:

setAttributor in interface P2DLegendModelInterface

Parameters:

attributor - The title attributor

getAttributor

public P2DAttributorInterface getAttributor(P2DLegendInterface component)

Get the title attributor.

Specified by:

getAttributor in interface P2DLegendModelInterface

Returns:

The title attributor

getAttributedText

public FwkArrayInterface getAttributedText(P2DLegendInterface component)

Get the attributed string of the text.

Specified by:

getAttributedText in interface P2DLegendModelInterface

Returns:

An array containing the attributed text value.

setAlignment

public void setAlignment(P2DLegendInterface component,
                float ali)

Set the alignment of the text.

Specified by:

setAlignment in interface P2DLegendModelInterface

Parameters:

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

getAlignment

public float getAlignment(P2DLegendInterface component)

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

Specified by:

getAlignment in interface P2DLegendModelInterface

Returns:

the alignment value.

propertyChange

public void propertyChange(java.beans.PropertyChangeEvent ev)

The property change listener.

Specified by:

propertyChange in interface java.beans.PropertyChangeListener

Parameters:

ev - the propertyChangeEvent.