com.highqsoft.interfaces.fwk

Interface FwkInfoBusConsumerInterface

All Superinterfaces:

java.awt.datatransfer.ClipboardOwner, java.lang.Comparable, javax.infobus.DataItem, java.util.EventListener, FwkCompareInterface, FwkControlledByInterface, FwkControllerInterface, FwkDescriptionInterface, FwkInfoBusMemberInterface, FwkInstructionInterface, FwkInterface, FwkItemInterface, FwkMimeTypeInterface, FwkPersistenceInterface, FwkPresentationInterface, FwkPropertyChangeInterface, FwkTransferableInterface, FwkVetoableChangeInterface, javax.infobus.InfoBusDataConsumer, javax.infobus.InfoBusEventListener, javax.infobus.InfoBusMember, java.beans.PropertyChangeListener, java.io.Serializable, java.awt.datatransfer.Transferable

All Known Subinterfaces:

FwkApplicationConsumerInterface, OdsxPresentableElementConsumerInterface, OdsxPresentorInterface, P2DChannelModelInterface

All Known Implementing Classes:

AsamCommanderInstanceSelectorPane.OdsxItemConsumer, AsamCommanderOdsSessionConsumer, Cmd, CmdClose, CmdConnect, CmdDescribe, CmdEcho, CmdExit, CmdHelp, CmdJournal, CmdList, CmdSelect, CmdSource, ColumnDisplay.ColumnConsumer, ColumnDisplay.LayouterConsumer, FileConsumer, FwkAliasConsumer, FwkApplicationConsumer, FwkDataItemConsumer, FwkInfoBusConsumer, FwkInfoBusImmediateAccess.ElementConsumer, FwkInfoBusItemList.ItemListConsumer, FwkPropertyConsumer, ItemList.ItemListConsumer, JournalConsumer, MED.LayouterConsumer, MEDCalculatorBasicPane.InfoBusChannelConsumer, MEDCalculatorBasicPane.InfoBusMarkerConsumer, MEDInfoBusSelectionDialogPane.InfoBusConsumer, OdsxPresentableElementConsumer, OdsxPresentor, OdsxSelector.OdsxPathConsumer, OdsxSessionConsumer, P2DChannel.InfoBusDataConsumer, P2DChannelModel, P2DComponentConsumer, P2DMarkerConsumer, ProducerSelector.MimeTypeConsumer, ProducerSelector.ProducerSelectorConsumer

public interface FwkInfoBusConsumerInterface
extends FwkMimeTypeInterface, FwkControlledByInterface, javax.infobus.InfoBusDataConsumer, javax.infobus.InfoBusEventListener

The FwkInfoBusConsumerInterface describes the functionality of an infobus data item consumer.

Since:

$Date: 2017/04/28 08:47:43 $

Version:

$Revision: 1.11 $

Author:

HighQSoft GmbH

See Also:

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BUSNAME The name of the ConsumerBus.

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
java.lang.Object	findDataItem(java.lang.String dataItemName) Seeks a DataItem for a given data item name.
java.lang.Object	findDataItem(java.lang.String dataItemName, java.awt.datatransfer.DataFlavor[] flavors) Seeks a DataItem for a given data item name.
java.lang.Object[]	findMultipleDataItems(java.lang.String dataItemName) Seeks all available dataitems that match the pattern.
java.lang.Object[]	findMultipleDataItems(java.lang.String dataItemName, java.awt.datatransfer.DataFlavor[] flavors) Seeks all available dataitems that match the pattern.
boolean	isAssignable(java.awt.datatransfer.DataFlavor[] flavors) Return a boolean whether the given data flavors are assignable from this consumer.
void	register() Register the consumer.
void	unregister() Unregister the consumer.

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkMimeTypeInterface

addMimeType, getDataFlavor, getDataFlavors, getMimeTypes, removeMimeType

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

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkControlledByInterface

getController, setController

Methods inherited from interface javax.infobus.InfoBusDataConsumer

dataItemAvailable, dataItemRevoked

Methods inherited from interface java.beans.PropertyChangeListener

propertyChange

Field Detail

BUSNAME

static final java.lang.String BUSNAME

The name of the ConsumerBus.

See Also:

Constant Field Values

Method Detail

unregister

void unregister()

Unregister the consumer. Use this method before disconnect or finalize the instance.

register

void register()

Register the consumer.

isAssignable

boolean isAssignable(java.awt.datatransfer.DataFlavor[] flavors)

Return a boolean whether the given data flavors are assignable from this consumer.

Returns:

true if one of the given data flavors are assignable.

findDataItem

java.lang.Object findDataItem(java.lang.String dataItemName)

Seeks a DataItem for a given data item name. The method looks for data items that support one of the flavors supported by this consumer.

Parameters:

dataItemName - The item to be found.

findDataItem

java.lang.Object findDataItem(java.lang.String dataItemName,
                            java.awt.datatransfer.DataFlavor[] flavors)

Seeks a DataItem for a given data item name.

Parameters:

dataItemName - The item to be found.

flavors - The flavors that should be support by the item.

findMultipleDataItems

java.lang.Object[] findMultipleDataItems(java.lang.String dataItemName)

Seeks all available dataitems that match the pattern. The method looks for data items that support one of the flavors supported by this consumer.

Parameters:

pattern - The dataitem pattern.

flavors - The flavors that should be support by the item.

findMultipleDataItems

java.lang.Object[] findMultipleDataItems(java.lang.String dataItemName,
                                       java.awt.datatransfer.DataFlavor[] flavors)

Seeks all available dataitems that match the pattern.

Parameters:

pattern - The dataitem pattern.

flavors - The flavors that should be support by the item.