com.highqsoft.interfaces.p2d

Interface P2DTextModelInterface

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:

ColumnDisplayPanel.TextModel, OdsxLayouterCommand.TextModel, P2DTextModel

public interface P2DTextModelInterface
extends P2DModelInterface

The P2DTextModelInterface defines the text model behaviour.

Since:

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

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
float	getAlignment(P2DTextInterface component) Get the alignment value.
FwkArrayInterface	getAttributedText(P2DTextInterface component) Get the attributed string of the text.
P2DAttributorInterface	getAttributor(P2DComponentInterface component) Get the title attributor.
java.lang.String	getLine(P2DTextInterface component, int index) Retrieves a line according to the specified index.
int	getSize(P2DTextInterface component) Retrieves the size of the array.
java.lang.String	getText(P2DTextInterface component) Retrievs the text string.
FwkArrayInterface	getTextArray(P2DTextInterface component) Retrievs the text array of the object.
void	setAlignment(P2DTextInterface component, float ali) Set the alignment of the text.
void	setAttributor(P2DComponentInterface component, P2DAttributorInterface attributor) Set the title attributor.
void	setText(P2DTextInterface component, java.lang.String text) Sets the text of the object.
void	setTextArray(P2DTextInterface component, FwkArrayInterface text) Sets the text array of the object.

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

setText

void setText(P2DTextInterface component,
           java.lang.String text)

Sets the text of the object. This method clears the internal vector of text and add the new lines to it. Multiple line are separated by "\n". This routine fires a PropertyChangeEvent on propterty Text.

Parameters:

text - The new text of the object.

setTextArray

void setTextArray(P2DTextInterface component,
                FwkArrayInterface text)

Sets the text array of the object. This method clears the internal vector before. This routine fires a PropertyChangeEvent on propterty Text.

Parameters:

text - The new text array of the object.

getTextArray

FwkArrayInterface getTextArray(P2DTextInterface component)

Retrievs the text array of the object.

Returns:

The text string of the object.

getText

java.lang.String getText(P2DTextInterface component)

Retrievs the text string. Lines are separated by \n.

Returns:

The text string of the object.

getSize

int getSize(P2DTextInterface component)

Retrieves the size of the array.

Returns:

The size of array.

getLine

java.lang.String getLine(P2DTextInterface component,
                       int index)

Retrieves a line according to the specified index. If the index is out of range the method returns an empty string.

Parameters:

index - The line number to be retireved.

getAttributedText

FwkArrayInterface getAttributedText(P2DTextInterface component)

Get the attributed string of the text.

Returns:

An array containing the attributed text value.

setAlignment

void setAlignment(P2DTextInterface 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(P2DTextInterface component)

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

Returns:

the alignment value.

setAttributor

void setAttributor(P2DComponentInterface component,
                 P2DAttributorInterface attributor)

Set the title attributor.

Parameters:

attributor - The title attributor

getAttributor

P2DAttributorInterface getAttributor(P2DComponentInterface component)

Get the title attributor.

Returns:

The title attributor