com.highqsoft.interfaces.odsx

Interface OdsxFilterInterface

All Superinterfaces:

java.awt.datatransfer.ClipboardOwner, java.lang.Cloneable, FwkCommandInterface, FwkControlledByInterface, FwkControllerInterface, FwkDescriptionInterface, FwkDOMHandlerInterface, FwkInstructionInterface, FwkInterface, FwkPresentationInterface, FwkPropertyChangeInterface, FwkTransferableInterface, java.io.Serializable, java.awt.datatransfer.Transferable

All Known Implementing Classes:

OdsxFilter

public interface OdsxFilterInterface
extends FwkControllerInterface, FwkCommandInterface, FwkDOMHandlerInterface, java.lang.Cloneable

The OdsxFilterInterface is the interface for ASAM-ODS filter components.

Since:

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

Version:

$Revision: 1.13 $

Author:

HighQSoft GmbH

See Also:

Field Summary

Fields inherited from interface com.highqsoft.interfaces.fwk.FwkCommandInterface

CONTROLLER_PROPERTY, MENU_REASON_CANCELED, MENU_REASON_DESELECTED, MENU_REASON_SELECTED

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	addCommand(OdsxPresentableElementInterface presentable, FwkCommandInterface command) Add the command to the command array.
void	addCommand(OdsxPresentableElementInterface presentable, int index, FwkCommandInterface command) Insert a command at the specified position.
void	addToGroup(OdsxPresentableElementInterface presentable, int index, java.lang.String groupIdent, java.lang.String commandName) Add a command to a group.
void	addToGroup(OdsxPresentableElementInterface presentable, java.lang.String groupIdent, java.lang.String commandName) Add a command to a group.
java.lang.Object	clone() Clone the filter.
void	clone(OdsxFilterInterface filter) Clone the incoming filter.
boolean	commandsAvailable(OdsxPresentableElementInterface presentable) This method returns a boolean that indicates whether the command array is initialized.
void	delete(OdsxPresentableElementInterface elem) Delete an presentable element.
void	deleteGroup(OdsxPresentableElementInterface presentable, java.lang.String groupIdent) Delete command group.
java.lang.String	enableKey() Return the key for enable.
FwkPropertyGroupInterface	getBaseElementGroup() Returns the base element proproperty group.
java.util.Map	getBaseElementMap() Deprecated. use getBaseElementGroup() instread
java.awt.Color	getColor(OdsxPresentableElementInterface elem) Returns the color for the specified element.
FwkCommandInterface	getCommand(OdsxPresentableElementInterface presentable, java.lang.String commandName) Return the command that matches the given command name.
FwkCommandInterface[]	getCommands(OdsxPresentableElementInterface presentable) Retrieve the command array of the component.
boolean	getEnableApplicationElements() Get the enable flag of the application elements.
boolean	getEnabled() Get the enable flag of the filter.
boolean	getEnableInstanceElements() Get the enable flag of the instance elements.
FwkCommandInterface[]	getGroup(OdsxPresentableElementInterface presentable, java.lang.String groupIdent) Retrieve the command group.
FwkIconInterface	getIcon(OdsxPresentableElementInterface elem) Returns the icon for the specified element.
FwkPropertyGroupInterface	getPropertyGroup() Get the porperty group.
boolean	getRecursiveApplStructEnabled() Get a boolean whether the application structure will resolve recursive structure.
java.lang.String	getTranslatedKey(java.lang.String key, java.lang.String defaultValue) Translate a text key.
java.lang.String	getTranslatedName(OdsxPresentableElementInterface elem) Returns the filtered name of the element.
OdsxFilterValueInterface	getValue(java.lang.String key) Get filter value.
boolean	groupExists(OdsxPresentableElementInterface presentable, java.lang.String groupIdent) Check whether a group exists.
boolean	isEditable(java.lang.String key) Is the given key editable.
boolean	isEnabled(OdsxPresentableElementInterface elem) Check if the element is enabled by this filter.
boolean	isEnabled(java.lang.String key, boolean defaultValue) Check if the given key has an enabled entry in filter.
boolean	isVisible(OdsxPresentableElementInterface elem) Check if the element is visible by this filter.
boolean	isVisible(java.lang.String key, boolean defaultValue) Check if the given key has a visible entry in filter.
java.lang.String	nameKey() Return the name key.
void	removeCommand(OdsxPresentableElementInterface presentable, FwkCommandInterface command) Remove a sub-command.
void	removeFromGroup(OdsxPresentableElementInterface presentable, java.lang.String groupIdent, java.lang.String commandName) Remove a command from a group.
void	setBaseElementGroup(FwkPropertyGroupInterface group) Sets a base element property group.
void	setBaseElementMap(java.util.Map map) Deprecated. use setBaseElementGroup(FwkPropertyGroup) instread
void	setColor(OdsxPresentableElementInterface elem, java.awt.Color color) Sets the color for the specified element.
void	setCommands(OdsxPresentableElementInterface presentable, FwkCommandInterface[] commands) Set the sub-commands of the command.
void	setEnableApplicationElements(boolean flag) Enable the application elements.
void	setEnabled(boolean flag) Enable the filter.
void	setEnabled(OdsxPresentableElementInterface elem, boolean flag) Check if the element is enabled by this filter.
void	setEnableInstanceElements(boolean flag) Enable the instance elements.
void	setIcon(OdsxPresentableElementInterface elem, FwkIconInterface icon) Sets the icon for the specified element.
void	setRecursiveApplStructEnabled(boolean flag) Set a boolean whether the application structure will resolve recursive structure.
void	setTranslatedKey(java.lang.String key, java.lang.String value) Set key word to be translated to a value.
void	setTranslatedName(OdsxPresentableElementInterface elem, java.lang.String value) Returns the filtered name of the element.
void	setValue(java.lang.String group, OdsxFilterValueInterface value) Set a filter value.
void	setVisible(OdsxPresentableElementInterface elem, boolean flag) Check if the element is visible by this filter.
java.lang.String	valueKey() Return the value key.
java.lang.String	visibleKey() Return the key for visible.

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

destroyController

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

addActionListener, addMenuListener, execute, getActionListenerArray, getButtonClass, getCommandName, getHelpID, getIcon, getIconKey, getMenuEventEnabled, getMenuItemClass, getMenuListenerArray, getMnemonic, getProperties, getProperty, getRadioGroupState, getSensitivity, getSeparator, getText, getTextKey, getToggle, getToggleState, getToolBarEnabled, getToolTipKey, getToolTipText, getVisibility, hasActionListeners, hasMenuListeners, isParent, menuSelect, register, registeredObjects, registrySize, removeActionListener, removeMenuListener, setAsParent, setButtonClass, setCommandName, setHelpID, setIcon, setIconKey, setMenuEventEnabled, setMenuItemClass, setMnemonic, setProperty, setRadioGroupState, setSensitivity, setSeparator, setText, setTextKey, setToggle, setToggleState, setToolBarEnabled, setToolTipKey, setToolTipText, setVisibility, unregister

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 com.highqsoft.interfaces.fwk.FwkControlledByInterface

getController, setController

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.FwkDOMHandlerInterface

getCompany, readConstructor, readFromDOM, readingDOM, readingDOM, writeConstructor, writeToDOM, writeToXML

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

getAuthor, getBuild, getClassName, 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

Method Detail

getColor

java.awt.Color getColor(OdsxPresentableElementInterface elem)

Returns the color for the specified element.

Parameters:

elem - The presentable element.

Returns:

The color of the element.

setColor

void setColor(OdsxPresentableElementInterface elem,
            java.awt.Color color)

Sets the color for the specified element.

Parameters:

elem - The presentable element.

color - The new color for the element.

getIcon

FwkIconInterface getIcon(OdsxPresentableElementInterface elem)

Returns the icon for the specified element.

Parameters:

elem - The presentable element.

Returns:

The icon of the element.

setIcon

void setIcon(OdsxPresentableElementInterface elem,
           FwkIconInterface icon)

Sets the icon for the specified element.

Parameters:

elem - The presentable element.

icon - The new icon for the element.

setEnabled

void setEnabled(boolean flag)

Enable the filter.

Parameters:

flag - true if the filter will be enabled.

getEnabled

boolean getEnabled()

Get the enable flag of the filter.

Parameters:

true - if the filter id enabled.

setEnableInstanceElements

void setEnableInstanceElements(boolean flag)

Enable the instance elements.

Parameters:

flag - true if the instance elements will be enabled.

getEnableInstanceElements

boolean getEnableInstanceElements()

Get the enable flag of the instance elements.

Parameters:

true - if the filter id enabled to display instance elements.

setEnableApplicationElements

void setEnableApplicationElements(boolean flag)

Enable the application elements.

Parameters:

flag - true if the application elements will be enabled.

getEnableApplicationElements

boolean getEnableApplicationElements()

Get the enable flag of the application elements.

Parameters:

true - if the filter id enabled to display application elements.

isEnabled

boolean isEnabled(OdsxPresentableElementInterface elem)

Check if the element is enabled by this filter.

Parameters:

elem - The presentable element.

Returns:

True if the element passes the filter.

isEnabled

boolean isEnabled(java.lang.String key,
                boolean defaultValue)

Check if the given key has an enabled entry in filter.

Parameters:

key - The key value.

defaultValue - The default return value.

isVisible

boolean isVisible(OdsxPresentableElementInterface elem)

Check if the element is visible by this filter.

Parameters:

elem - The presentable element.

Returns:

True if the element is visible.

isVisible

boolean isVisible(java.lang.String key,
                boolean defaultValue)

Check if the given key has a visible entry in filter.

Parameters:

key - The key value.

defaultValue - The default return value.

setEnabled

void setEnabled(OdsxPresentableElementInterface elem,
              boolean flag)

Check if the element is enabled by this filter.

Parameters:

elem - The presentable element.

flag - true if the element should be endabled.

setVisible

void setVisible(OdsxPresentableElementInterface elem,
              boolean flag)

Check if the element is visible by this filter.

Parameters:

elem - The presentable element.

flag - true if the element should be visible.

getTranslatedName

java.lang.String getTranslatedName(OdsxPresentableElementInterface elem)

Returns the filtered name of the element.

Parameters:

elem - The presentable element.

Returns:

The filtered name value.

setTranslatedName

void setTranslatedName(OdsxPresentableElementInterface elem,
                     java.lang.String value)

Returns the filtered name of the element.

Parameters:

elem - The presentable element.

value - The new translation value.

getValue

OdsxFilterValueInterface getValue(java.lang.String key)

Get filter value.

Parameters:

key - The key for that the value should be restore.

Returns:

null or the value.

setValue

void setValue(java.lang.String group,
            OdsxFilterValueInterface value)

Set a filter value.

Parameters:

group - The name of the group.

value - the filter value.

getTranslatedKey

java.lang.String getTranslatedKey(java.lang.String key,
                                java.lang.String defaultValue)

Translate a text key.

Parameters:

key - The text key.

defaultValue - The default value, if null the key will be returned.

Returns:

The filtered key value.

setTranslatedKey

void setTranslatedKey(java.lang.String key,
                    java.lang.String value)

Set key word to be translated to a value.

Parameters:

key - The text key.

value - the value.

delete

void delete(OdsxPresentableElementInterface elem)

Delete an presentable element.

Parameters:

elem - the element to be removed.

getBaseElementMap

java.util.Map getBaseElementMap()

Deprecated. use getBaseElementGroup() instread

Returns a map containing the visiblity for the base elements. The keyword is the name of the base element and the value is a boolean that indicates the visiblity.

Returns:

The map.

See Also:

getBaseElementGroup()

setBaseElementMap

void setBaseElementMap(java.util.Map map)

Deprecated. use setBaseElementGroup(FwkPropertyGroup) instread

Sets a map containing the visiblity for the base elements. The keyword is the name of the base element and the value is a boolean that indicates the visiblity.

See Also:

setBaseElementGroup(FwkPropertyGroup)

getBaseElementGroup

FwkPropertyGroupInterface getBaseElementGroup()

Returns the base element proproperty group. Each base element has the keys Name, Value, Visible and Enabled

Returns:

The group.

setBaseElementGroup

void setBaseElementGroup(FwkPropertyGroupInterface group)

Sets a base element property group. Each element can have the keys Name, Value, Visible and Enabled
Example: AoAny.Visible = false

addCommand

void addCommand(OdsxPresentableElementInterface presentable,
              FwkCommandInterface command)

Add the command to the command array.

Parameters:

elem - the presentable element.

command - The command to be added.

addCommand

void addCommand(OdsxPresentableElementInterface presentable,
              int index,
              FwkCommandInterface command)

Insert a command at the specified position. If the position is out of range. The method inserts the command at the beginning or appends it to existing array.

Parameters:

elem - the presentable element.

index - The position where the command has to be inserted.

command - The command to be added.

getCommand

FwkCommandInterface getCommand(OdsxPresentableElementInterface presentable,
                             java.lang.String commandName)

Return the command that matches the given command name.

Parameters:

elem - the presentable element.

commandName - The name of the requested command.

Returns:

The command or null if no matching command found.

getCommands

FwkCommandInterface[] getCommands(OdsxPresentableElementInterface presentable)

Retrieve the command array of the component.

Parameters:

elem - the presentable element.

Returns:

The array containing the commands.

removeCommand

void removeCommand(OdsxPresentableElementInterface presentable,
                 FwkCommandInterface command)

Remove a sub-command. This method fires a property change event on the property RemoveCommand. The new value object of the event is this the old value object is the removed sub-command.

Parameters:

elem - the presentable element.

command - The sub-command to be removed.

setCommands

void setCommands(OdsxPresentableElementInterface presentable,
               FwkCommandInterface[] commands)

Set the sub-commands of the command. All existing sub-commands will be removed.

Parameters:

elem - the presentable element.

commands - The array containing the sub-commands.

commandsAvailable

boolean commandsAvailable(OdsxPresentableElementInterface presentable)

This method returns a boolean that indicates whether the command array is initialized.

Parameters:

elem - the presentable element.

Returns:

true if the command array is already initialized.

addToGroup

void addToGroup(OdsxPresentableElementInterface presentable,
              int index,
              java.lang.String groupIdent,
              java.lang.String commandName)

Add a command to a group.

Parameters:

elem - the presentable element.

index - Index where the command should be placed.

groupIdent - The string identified of the group.

commandName - The name of the command.

addToGroup

void addToGroup(OdsxPresentableElementInterface presentable,
              java.lang.String groupIdent,
              java.lang.String commandName)

Add a command to a group.

Parameters:

elem - the presentable element.

groupIdent - The string identified of the group.

commandName - The name of the command.

removeFromGroup

void removeFromGroup(OdsxPresentableElementInterface presentable,
                   java.lang.String groupIdent,
                   java.lang.String commandName)

Remove a command from a group.

Parameters:

elem - the presentable element.

groupIdent - The string identified of the group.

commandName - The name of the command.

deleteGroup

void deleteGroup(OdsxPresentableElementInterface presentable,
               java.lang.String groupIdent)

Delete command group.

Parameters:

elem - the presentable element.

groupIdent - The string identified of the group.

getGroup

FwkCommandInterface[] getGroup(OdsxPresentableElementInterface presentable,
                             java.lang.String groupIdent)

Retrieve the command group.

Parameters:

elem - the presentable element.

groupIdent - The string identified of the group.

Returns:

An array containing the group commands or null if empty.

groupExists

boolean groupExists(OdsxPresentableElementInterface presentable,
                  java.lang.String groupIdent)

Check whether a group exists.

Parameters:

elem - the presentable element.

Returns:

true if the group exists.

getRecursiveApplStructEnabled

boolean getRecursiveApplStructEnabled()

Get a boolean whether the application structure will resolve recursive structure.

Returns:

true if recursive struture should be resolved.

setRecursiveApplStructEnabled

void setRecursiveApplStructEnabled(boolean flag)

Set a boolean whether the application structure will resolve recursive structure.

Parameters:

flag - true if recursive struture should be resolved.

clone

java.lang.Object clone()

Clone the filter.

Returns:

the clone object.

getPropertyGroup

FwkPropertyGroupInterface getPropertyGroup()

Get the porperty group.

Returns:

a reference property group.

visibleKey

java.lang.String visibleKey()

Return the key for visible.

Returns:

the visible key.

enableKey

java.lang.String enableKey()

Return the key for enable.

Returns:

the enable key.

valueKey

java.lang.String valueKey()

Return the value key.

Parameters:

the - value key.

nameKey

java.lang.String nameKey()

Return the name key.

Parameters:

the - name key.

isEditable

boolean isEditable(java.lang.String key)

Is the given key editable.

Returns:

true if the given key is editable.

clone

void clone(OdsxFilterInterface filter)

Clone the incoming filter. This method copies all entries from the incoming value into this object.

Parameters:

filter - The filter from that the configuration should be copied.