OdsxFilter

java.lang.Object
- com.highqsoft.fwk.Fwk
- - com.highqsoft.fwk.FwkDescription
  - - com.highqsoft.fwk.FwkPropertyChange
    - - com.highqsoft.fwk.FwkCommand
      - com.highqsoft.odsx.OdsxFilter

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

public class OdsxFilter
extends FwkCommand
implements FwkControllerInterface, OdsxFilterInterface

The OdsxFilter is the implementation of the OdsxFilterInterface.
The property OdsxFilter.ResursiveApplStructEnabled hoöds a boolean that decides whether the filter enables the display of recursive application structures. The default value is false (display no recursive structure).

Property Keyword	Datatype	Default	Description
OdsxFilter.ResursiveApplStructEnabled	boolean	false	This flag enables the recursive display of the application structure.
OdsxFilter.InstanceElements.Enabled	boolean	true	Flag to disable the instance elements.
OdsxFilter.Text.View	String	OdsxFilter.Text.View	The title of the View submenu.
OdsxFilter.Text.Disabled	String	OdsxFilter.Text.Disabled	The title of the Disable submenu.
OdsxFilter.Disabled	Boolean	false	If true the filter is disabled by default.
OdsxFilter.Text.Help	String	OdsxFilter.Text.Help	The title of the Help submenu.
OdsxFilter.Text.HelpBroker	String	OdsxFilter.Text.HelpBroker	The title of the HelpBorker submenu.
OdsxFilter.Text.About	String	OdsxFilter.Text.About	The title of the About submenu.
Icon.About	Icon	com/highqsoft/fwk/images/About.gif	The icon of the About submenu.
Icon.View	Icon	com/highqsoft/fwk/images/View.gif	The icon of the View submenu.
Icon.Help	Icon	com/highqsoft/fwk/images/Help.gif	The icon of the Help submenu.

The filter uses the java.util.prefs.Preferences class to get and put following preferences:

OdsxFilter.enabled

boolean

false

If this flag is true, then the filter is active.

Since:: $Date: 2017/04/06 13:29:49 $
Version:: $Revision: 1.14 $
Author:: Andreas Hofmann
See Also:: , Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`java.awt.Color`	`APPLICATION_ELEMENT_COLOR`
`static java.lang.String`	`APPLICATIONATTRIBUTE`
`static java.lang.String`	`APPLICATIONELEMENT`
`protected boolean`	`applicationElementEnabled` The flag that indicates whether the application elements are enabled.
`static java.lang.String`	`BASEATTRIBUTE`
`static java.lang.String`	`BASEELEMENT`
`static java.lang.String`	`BASEELEMENTMAP_NAME`
`java.awt.Color`	`COLUMN_COLOR`
`java.awt.Color`	`DEFAULT_COLOR`
`protected static FwkDescriptionInterface`	`descriptor`
`protected boolean`	`enabled` The flag that indicates whether the filter is enabled.
`static java.lang.String`	`ENABLED`
`java.awt.Color`	`INSTANCE_ELEMENT_COLOR`
`static java.lang.String`	`INSTANCEATTRIBUTE`
`static java.lang.String`	`INSTANCEELEMENT`
`protected boolean`	`instanceElementEnabled` The flag that indicates whether the instance elements are enabled.
`static java.lang.String`	`NAME`
`static java.lang.String`	`NAMEVALUEMAP_NAME`
`protected static java.lang.String`	`PREFS_ENABLED`
`protected boolean`	`readingDOM` The flag that indicates the XML reading.
`protected boolean`	`recursiveApplStruct` The flag for the recursive application structure display.
`protected java.net.URL`	`url` The URL to the filter file.
`static java.lang.String`	`VALUE`
`protected FwkPropertyGroupInterface`	`valuePropGroup` The property group that hold the value info.
`static java.lang.String`	`version`
`static java.lang.String`	`VISIBLE`

Fields inherited from class com.highqsoft.fwk.FwkCommand
actionListeners, buttonClass, commandName, helpID, icon, iconKey, instruction, menuEventEnabled, menuItemClass, menuListeners, mnemonic, properties, radioGroupState, registry, sensitive, separator, text, textKey, toggle, toggleState, toolBarEnabled, toolTipKey, toolTipText, visible

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, iconCount, internetAddress, name, titleName

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

Constructor Summary

Constructors
Modifier Constructor and Description

OdsxFilter()
The default constructor.

protected OdsxFilter(boolean cloned)
The constructor to clone the object.

Constructors
Modifier	Constructor and Description
	`OdsxFilter()` The default constructor.
`protected`	`OdsxFilter(boolean cloned)` The constructor to clone the object.

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 object.
`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.
`protected FwkPropertyGroupInterface`	`createGroupForElement(OdsxPresentableElementInterface elem)` Create a group for the given element.
`protected FwkPropertyGroupInterface`	`createGroupForKey(java.lang.String key)` Create a group for the given element.
`void`	`delete(OdsxPresentableElementInterface elem)` Delete an presentable element.
`void`	`deleteGroup(OdsxPresentableElementInterface presentable, java.lang.String groupIdent)` Delete command group.
`boolean`	`destroyController()` Destroy the controller.
`java.lang.String`	`enableKey()` Return the key for enable.
`FwkPropertyGroupInterface`	`getBaseElementGroup()` Returns the base element proproperty group.
`java.util.Map`	`getBaseElementMap()` Deprecated. Use getBaseElementGroup instead
`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()` Get the command array from the filter.
`FwkCommandInterface[]`	`getCommands(OdsxPresentableElementInterface presentable)` Retrieve the command array of the component.
`static FwkDescriptionInterface`	`getDescriptor()`
`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.
`protected FwkPropertyGroupInterface`	`getGroupForElement(OdsxPresentableElementInterface elem)` Get the group for the given element.
`protected FwkPropertyGroupInterface`	`getGroupForKey(java.lang.String key)` Get the group for the given key.
`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`	`getText()` Overload the getText method.
`java.lang.String`	`getTranslatedKey(java.lang.String key, java.lang.String defaultValue)` Returns the filtered key of the element.
`java.lang.String`	`getTranslatedName(OdsxPresentableElementInterface elem)` Returns the filtered name of the element.
`OdsxFilterValueInterface`	`getValue(java.lang.String key)` Get filter value.
`java.lang.String`	`getVersion()` Return the version string of the FWK component.
`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.
`java.lang.Object`	`readConstructor(org.w3c.dom.Document document, org.w3c.dom.Element node)` Read a construtor dom node.
`void`	`readFromDOM(org.w3c.dom.Document doc, org.w3c.dom.Element element)` Read from DOM
`boolean`	`readingDOM()` Get the DOM reading flag.
`void`	`readingDOM(boolean flag)` Set a flag that the object is currently reading the DOM.
`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)` Deprecated. Use setBaseElementGroup instead
`void`	`setBaseElementMap(java.util.Map map)` Deprecated. Use setBaseElementGroup instead
`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 the filtered key of the element.
`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`	`toString()` The to string method.
`java.lang.String`	`valueKey()` Return the value key.
`java.lang.String`	`visibleKey()` Return the key for visible.
`org.w3c.dom.Element`	`writeConstructor(org.w3c.dom.Document document, FwkXmlDtdInterface dtd, org.w3c.dom.Node node, java.util.Map classProperties)` Write a construtor dom node.
`org.w3c.dom.Element`	`writeToDOM(org.w3c.dom.Document document, FwkXmlDtdInterface dtd, org.w3c.dom.Node node, java.util.Map classProperties)` Write the container as child to the given DOM node.
`boolean`	`writeToXML(java.lang.String filename, boolean validate)` Writes the canvas to an XML file.

Methods inherited from class com.highqsoft.fwk.FwkCommand
addActionListener, addCommand, addCommand, addMenuListener, addToGroup, addToGroup, clearCommands, commandsAvailable, deleteGroup, execute, getActionListenerArray, getButtonClass, getCommand, getCommandName, getController, getGroup, getHelpID, getIcon, getIconKey, getMenuEventEnabled, getMenuItemClass, getMenuListenerArray, getMnemonic, getProperties, getProperty, getRadioGroupState, getSensitivity, getSeparator, getTextKey, getToggle, getToggleState, getToolBarEnabled, getToolTipKey, getToolTipText, getVisibility, groupExists, hasActionListeners, hasMenuListeners, isParent, menuSelect, register, registeredObjects, registrySize, removeActionListener, removeCommand, removeFromGroup, removeMenuListener, setAsParent, setButtonClass, setCommandName, setCommands, setController, setHelpID, setIcon, setIconKey, setMenuEventEnabled, setMenuItemClass, setMnemonic, setProperty, setRadioGroupState, setSensitivity, setSeparator, setText, setTextKey, setToggle, setToggleState, setToolBarEnabled, setToolTipKey, setToolTipText, setVisibility, unregister

Methods inherited from class com.highqsoft.fwk.Fwk
getNiceVersion, release

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkControlledByInterface
getController, setController

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkDOMHandlerInterface
getCompany

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

- Field Detail
  - PREFS_ENABLED
```
protected static final java.lang.String PREFS_ENABLED
```
    See Also:
    Constant Field Values
  - DEFAULT_COLOR
```
public final java.awt.Color DEFAULT_COLOR
```
  - INSTANCE_ELEMENT_COLOR
```
public final java.awt.Color INSTANCE_ELEMENT_COLOR
```
  - APPLICATION_ELEMENT_COLOR
```
public final java.awt.Color APPLICATION_ELEMENT_COLOR
```
  - COLUMN_COLOR
```
public final java.awt.Color COLUMN_COLOR
```
  - BASEELEMENTMAP_NAME
```
public static final java.lang.String BASEELEMENTMAP_NAME
```
    See Also:
    Constant Field Values
  - NAMEVALUEMAP_NAME
```
public static final java.lang.String NAMEVALUEMAP_NAME
```
    See Also:
    Constant Field Values
  - APPLICATIONATTRIBUTE
```
public static final java.lang.String APPLICATIONATTRIBUTE
```
    See Also:
    Constant Field Values
  - APPLICATIONELEMENT
```
public static final java.lang.String APPLICATIONELEMENT
```
    See Also:
    Constant Field Values
  - INSTANCEELEMENT
```
public static final java.lang.String INSTANCEELEMENT
```
    See Also:
    Constant Field Values
  - INSTANCEATTRIBUTE
```
public static final java.lang.String INSTANCEATTRIBUTE
```
    See Also:
    Constant Field Values
  - BASEELEMENT
```
public static final java.lang.String BASEELEMENT
```
    See Also:
    Constant Field Values
  - BASEATTRIBUTE
```
public static final java.lang.String BASEATTRIBUTE
```
    See Also:
    Constant Field Values
  - VISIBLE
```
public static final java.lang.String VISIBLE
```
    See Also:
    Constant Field Values
  - ENABLED
```
public static final java.lang.String ENABLED
```
    See Also:
    Constant Field Values
  - NAME
```
public static final java.lang.String NAME
```
    See Also:
    Constant Field Values
  - VALUE
```
public static final java.lang.String VALUE
```
    See Also:
    Constant Field Values
  - version
```
public static final java.lang.String version
```
    See Also:
    Constant Field Values
  - descriptor
```
protected static final FwkDescriptionInterface descriptor
```
  - readingDOM
```
protected boolean readingDOM
```
    The flag that indicates the XML reading.
  - enabled
```
protected boolean enabled
```
    The flag that indicates whether the filter is enabled.
  - instanceElementEnabled
```
protected boolean instanceElementEnabled
```
    The flag that indicates whether the instance elements are enabled.
  - applicationElementEnabled
```
protected boolean applicationElementEnabled
```
    The flag that indicates whether the application elements are enabled.
  - valuePropGroup
```
protected FwkPropertyGroupInterface valuePropGroup
```
    The property group that hold the value info.
  - url
```
protected java.net.URL url
```
    The URL to the filter file.
  - recursiveApplStruct
```
protected boolean recursiveApplStruct
```
    The flag for the recursive application structure display.
- Constructor Detail
  - OdsxFilter
```
public OdsxFilter()
```
    The default constructor.
  - OdsxFilter
```
protected OdsxFilter(boolean cloned)
```
    The constructor to clone the object.
- Method Detail
  - getVersion
```
public java.lang.String getVersion()
```
    Description copied from interface: FwkInterface
    
    Return the version string of the FWK component.
    
    Specified by:
    
    getVersion in interface FwkInterface
    
    Overrides:
    
    getVersion in class FwkCommand
  - getDescriptor
```
public static FwkDescriptionInterface getDescriptor()
```
  - clone
```
public java.lang.Object clone()
```
    Clone the object.
    
    Specified by:
    
    clone in interface OdsxFilterInterface
    
    Overrides:
    
    clone in class java.lang.Object
    
    Returns:
    a odsx filter or null if not possible.
  - clone
```
public void clone(OdsxFilterInterface filter)
```
    Clone the incoming filter. This method copies all entries from the incoming value into this object.
    
    Specified by:
    
    clone in interface OdsxFilterInterface
    
    Parameters:
    filter - The filter from that the configuration should be copied.
  - getPropertyGroup
```
public FwkPropertyGroupInterface getPropertyGroup()
```
    Get the porperty group.
    
    Specified by:
    
    getPropertyGroup in interface OdsxFilterInterface
    
    Returns:
    a reference property group.
  - getCommands
```
public FwkCommandInterface[] getCommands()
```
    Get the command array from the filter.
    
    Specified by:
    
    getCommands in interface FwkInstructionInterface
    
    Overrides:
    
    getCommands in class FwkCommand
    
    Returns:
    The command array.
  - getText
```
public java.lang.String getText()
```
    Overload the getText method. It returns the title name of the filter.
    
    Specified by:
    
    getText in interface FwkCommandInterface
    
    Overrides:
    
    getText in class FwkCommand
    
    Parameters:
    The - filter name.
    
    Returns:
    The command text.
    See Also:
    FwkCommand.setText(String), FwkCommand.getTextKey()
  - setEnabled
```
public void setEnabled(boolean flag)
```
    Enable the filter.
    
    Specified by:
    
    setEnabled in interface OdsxFilterInterface
    
    Parameters:
    flag - true if the filter will be enabled.
  - getEnabled
```
public boolean getEnabled()
```
    get the enable flag of the filter.
    
    Specified by:
    
    getEnabled in interface OdsxFilterInterface
    
    Parameters:
    true - if the filter id enabled.
  - isEnabled
```
public boolean isEnabled(OdsxPresentableElementInterface elem)
```
    Check if the element is enabled by this filter.
    
    Specified by:
    
    isEnabled in interface OdsxFilterInterface
    
    Parameters:
    elem - The presentable element.
    
    Returns:
    True if the element passes the filter.
  - isEnabled
```
public boolean isEnabled(java.lang.String key,
                boolean defaultValue)
```
    Check if the given key has an enabled entry in filter.
    
    Specified by:
    
    isEnabled in interface OdsxFilterInterface
    
    Parameters:
    key - The key value.
    defaultValue - The default return value.
  - setEnableInstanceElements
```
public void setEnableInstanceElements(boolean flag)
```
    Enable the instance elements.
    
    Specified by:
    
    setEnableInstanceElements in interface OdsxFilterInterface
    
    Parameters:
    flag - true if the instance elements will be enabled.
  - getEnableInstanceElements
```
public boolean getEnableInstanceElements()
```
    Get the enable flag of the instance elements.
    
    Specified by:
    
    getEnableInstanceElements in interface OdsxFilterInterface
    
    Parameters:
    true - if the filter id enabled to display instance elements.
  - setEnableApplicationElements
```
public void setEnableApplicationElements(boolean flag)
```
    Enable the application elements.
    
    Specified by:
    
    setEnableApplicationElements in interface OdsxFilterInterface
    
    Parameters:
    flag - true if the application elements will be enabled.
  - getEnableApplicationElements
```
public boolean getEnableApplicationElements()
```
    Get the enable flag of the application elements.
    
    Specified by:
    
    getEnableApplicationElements in interface OdsxFilterInterface
    
    Parameters:
    true - if the filter id enabled to display application elements.
  - isVisible
```
public boolean isVisible(OdsxPresentableElementInterface elem)
```
    Check if the element is visible by this filter.
    
    Specified by:
    
    isVisible in interface OdsxFilterInterface
    
    Parameters:
    elem - The presentable element.
    
    Returns:
    True if the element is visible.
  - isVisible
```
public boolean isVisible(java.lang.String key,
                boolean defaultValue)
```
    Check if the given key has a visible entry in filter.
    
    Specified by:
    
    isVisible in interface OdsxFilterInterface
    
    Parameters:
    key - The key value.
    defaultValue - The default return value.
  - getGroupForKey
```
protected FwkPropertyGroupInterface getGroupForKey(java.lang.String key)
```
    Get the group for the given key.
  - createGroupForKey
```
protected FwkPropertyGroupInterface createGroupForKey(java.lang.String key)
```
    Create a group for the given element.
  - getGroupForElement
```
protected FwkPropertyGroupInterface getGroupForElement(OdsxPresentableElementInterface elem)
```
    Get the group for the given element.
  - createGroupForElement
```
protected FwkPropertyGroupInterface createGroupForElement(OdsxPresentableElementInterface elem)
```
    Create a group for the given element.
  - getIcon
```
public FwkIconInterface getIcon(OdsxPresentableElementInterface elem)
```
    Returns the icon for the specified element.
    
    Specified by:
    
    getIcon in interface OdsxFilterInterface
    
    Parameters:
    elem - The presentable element.
    
    Returns:
    The icon of the element.
  - setIcon
```
public void setIcon(OdsxPresentableElementInterface elem,
           FwkIconInterface icon)
```
    Sets the icon for the specified element.
    
    Specified by:
    
    setIcon in interface OdsxFilterInterface
    
    Parameters:
    elem - The presentable element.
    icon - The new icon for the element.
  - getColor
```
public java.awt.Color getColor(OdsxPresentableElementInterface elem)
```
    Returns the color for the specified element.
    
    Specified by:
    
    getColor in interface OdsxFilterInterface
    
    Parameters:
    elem - The presentable element.
    
    Returns:
    The color of the element.
  - setColor
```
public void setColor(OdsxPresentableElementInterface elem,
            java.awt.Color color)
```
    Sets the color for the specified element.
    
    Specified by:
    
    setColor in interface OdsxFilterInterface
    
    Parameters:
    elem - The presentable element.
    color - The new color for the element.
  - getTranslatedName
```
public java.lang.String getTranslatedName(OdsxPresentableElementInterface elem)
```
    Returns the filtered name of the element.
    
    Specified by:
    
    getTranslatedName in interface OdsxFilterInterface
    
    Parameters:
    elem - The presentable element.
    
    Returns:
    The filtered name value.
  - getTranslatedKey
```
public java.lang.String getTranslatedKey(java.lang.String key,
                                java.lang.String defaultValue)
```
    Returns the filtered key of the element.
    
    Specified by:
    
    getTranslatedKey in interface OdsxFilterInterface
    
    Parameters:
    key - The key to be translated.
    defaultValue - The default value.
    
    Returns:
    The filtered key value.
  - getValue
```
public OdsxFilterValueInterface getValue(java.lang.String key)
```
    Get filter value.
    
    Specified by:
    
    getValue in interface OdsxFilterInterface
    
    Parameters:
    key - The key for that the value should be restore.
    
    Returns:
    null or the value.
  - setValue
```
public void setValue(java.lang.String group,
            OdsxFilterValueInterface value)
```
    Set a filter value.
    
    Specified by:
    
    setValue in interface OdsxFilterInterface
    
    Parameters:
    group - The name of the group.
    value - the filter value.
  - setTranslatedKey
```
public void setTranslatedKey(java.lang.String key,
                    java.lang.String value)
```
    Set the filtered key of the element.
    
    Specified by:
    
    setTranslatedKey in interface OdsxFilterInterface
    
    Parameters:
    key - The key to be translated.
    value - The value.
  - getRecursiveApplStructEnabled
```
public boolean getRecursiveApplStructEnabled()
```
    Get a boolean whether the application structure will resolve recursive structure.
    
    Specified by:
    
    getRecursiveApplStructEnabled in interface OdsxFilterInterface
    
    Returns:
    true if recursive struture should be resolved.
  - setRecursiveApplStructEnabled
```
public void setRecursiveApplStructEnabled(boolean flag)
```
    Set a boolean whether the application structure will resolve recursive structure.
    
    Specified by:
    
    setRecursiveApplStructEnabled in interface OdsxFilterInterface
    
    Parameters:
    flag - true if recursive struture should be resolved.
  - setEnabled
```
public void setEnabled(OdsxPresentableElementInterface elem,
              boolean flag)
```
    Check if the element is enabled by this filter.
    
    Specified by:
    
    setEnabled in interface OdsxFilterInterface
    
    Parameters:
    elem - The presentable element.
    flag - true if the element should be endabled.
  - setVisible
```
public void setVisible(OdsxPresentableElementInterface elem,
              boolean flag)
```
    Check if the element is visible by this filter.
    
    Specified by:
    
    setVisible in interface OdsxFilterInterface
    
    Parameters:
    elem - The presentable element.
    flag - true if the element should be visible.
  - setTranslatedName
```
public void setTranslatedName(OdsxPresentableElementInterface elem,
                     java.lang.String value)
```
    Returns the filtered name of the element.
    
    Specified by:
    
    setTranslatedName in interface OdsxFilterInterface
    
    Parameters:
    elem - The presentable element.
    value - The new translation value.
  - delete
```
public void delete(OdsxPresentableElementInterface elem)
```
    Delete an presentable element.
    
    Specified by:
    
    delete in interface OdsxFilterInterface
    
    Parameters:
    elem - The element to be deleted.
  - getBaseElementMap
```
public java.util.Map getBaseElementMap()
```
    Deprecated. Use getBaseElementGroup instead
    
    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.
    
    Specified by:
    
    getBaseElementMap in interface OdsxFilterInterface
    
    Returns:
    The map.
    See Also:
    OdsxFilterInterface.getBaseElementGroup()
  - getBaseElementGroup
```
public FwkPropertyGroupInterface getBaseElementGroup()
```
    Returns the base element proproperty group. Each base element has the keys Name, Value, Visible and Enabled
    
    Specified by:
    
    getBaseElementGroup in interface OdsxFilterInterface
    
    Returns:
    The group.
  - setBaseElementMap
```
public void setBaseElementMap(java.util.Map map)
```
    Deprecated. Use setBaseElementGroup instead
    
    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.
    
    Specified by:
    
    setBaseElementMap in interface OdsxFilterInterface
    
    Parameters:
    map - The map.
    See Also:
    setBaseElementGroup(FwkPropertyGroup)
  - setBaseElementGroup
```
public void setBaseElementGroup(FwkPropertyGroupInterface group)
```
    Deprecated. Use setBaseElementGroup instead
    
    Sets a base element property group. Each element can have the keys Name, Value, Visible and Enabled
    Example: AoAny.Visible = false
    
    Specified by:
    
    setBaseElementGroup in interface OdsxFilterInterface
  - destroyController
```
public boolean destroyController()
```
    Destroy the controller.
    
    Specified by:
    
    destroyController in interface FwkControllerInterface
    
    Returns:
    true if the operation was successful.
  - addCommand
```
public void addCommand(OdsxPresentableElementInterface presentable,
              FwkCommandInterface command)
```
    Add the command to the command array.
    
    Specified by:
    
    addCommand in interface OdsxFilterInterface
    
    Parameters:
    elem - the presentable element.
    command - The command to be added.
  - addCommand
```
public 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.
    
    Specified by:
    
    addCommand in interface OdsxFilterInterface
    
    Parameters:
    elem - the presentable element.
    index - The position where the command has to be inserted.
    command - The command to be added.
  - getCommand
```
public FwkCommandInterface getCommand(OdsxPresentableElementInterface presentable,
                             java.lang.String commandName)
```
    Return the command that matches the given command name.
    
    Specified by:
    
    getCommand in interface OdsxFilterInterface
    
    Parameters:
    elem - the presentable element.
    commandName - The name of the requested command.
    
    Returns:
    The command or null if no matching command found.
  - getCommands
```
public FwkCommandInterface[] getCommands(OdsxPresentableElementInterface presentable)
```
    Retrieve the command array of the component.
    
    Specified by:
    
    getCommands in interface OdsxFilterInterface
    
    Parameters:
    elem - the presentable element.
    
    Returns:
    The array containing the commands.
  - removeCommand
```
public 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.
    
    Specified by:
    
    removeCommand in interface OdsxFilterInterface
    
    Parameters:
    elem - the presentable element.
    command - The sub-command to be removed.
  - setCommands
```
public void setCommands(OdsxPresentableElementInterface presentable,
               FwkCommandInterface[] commands)
```
    Set the sub-commands of the command. All existing sub-commands will be removed.
    
    Specified by:
    
    setCommands in interface OdsxFilterInterface
    
    Parameters:
    elem - the presentable element.
    commands - The array containing the sub-commands.
  - commandsAvailable
```
public boolean commandsAvailable(OdsxPresentableElementInterface presentable)
```
    This method returns a boolean that indicates whether the command array is initialized.
    
    Specified by:
    
    commandsAvailable in interface OdsxFilterInterface
    
    Parameters:
    elem - the presentable element.
    
    Returns:
    true if the command array is already initialized.
  - addToGroup
```
public void addToGroup(OdsxPresentableElementInterface presentable,
              int index,
              java.lang.String groupIdent,
              java.lang.String commandName)
```
    Add a command to a group.
    
    Specified by:
    
    addToGroup in interface OdsxFilterInterface
    
    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
```
public void addToGroup(OdsxPresentableElementInterface presentable,
              java.lang.String groupIdent,
              java.lang.String commandName)
```
    Add a command to a group.
    
    Specified by:
    
    addToGroup in interface OdsxFilterInterface
    
    Parameters:
    elem - the presentable element.
    groupIdent - The string identified of the group.
    commandName - The name of the command.
  - removeFromGroup
```
public void removeFromGroup(OdsxPresentableElementInterface presentable,
                   java.lang.String groupIdent,
                   java.lang.String commandName)
```
    Remove a command from a group.
    
    Specified by:
    
    removeFromGroup in interface OdsxFilterInterface
    
    Parameters:
    elem - the presentable element.
    groupIdent - The string identified of the group.
    commandName - The name of the command.
  - deleteGroup
```
public void deleteGroup(OdsxPresentableElementInterface presentable,
               java.lang.String groupIdent)
```
    Delete command group.
    
    Specified by:
    
    deleteGroup in interface OdsxFilterInterface
    
    Parameters:
    elem - the presentable element.
    groupIdent - The string identified of the group.
  - getGroup
```
public FwkCommandInterface[] getGroup(OdsxPresentableElementInterface presentable,
                             java.lang.String groupIdent)
```
    Retrieve the command group.
    
    Specified by:
    
    getGroup in interface OdsxFilterInterface
    
    Parameters:
    elem - the presentable element.
    groupIdent - The string identified of the group.
    
    Returns:
    An array containing the group commands or null if empty.
  - groupExists
```
public boolean groupExists(OdsxPresentableElementInterface presentable,
                  java.lang.String groupIdent)
```
    Check whether a group exists.
    
    Specified by:
    
    groupExists in interface OdsxFilterInterface
    
    Parameters:
    elem - the presentable element.
    
    Returns:
    true if the group exists.
  - readConstructor
```
public java.lang.Object readConstructor(org.w3c.dom.Document document,
                               org.w3c.dom.Element node)
```
    Read a construtor dom node.
    
    Specified by:
    
    readConstructor in interface FwkDOMHandlerInterface
    
    Parameters:
    document - The documnent Object Model.
    dtd - The dtd descriptor.
    node - The node.
    classProperties - Map the contains the writable object properties. May be null.
  readFromDOM
  
  public void readFromDOM(org.w3c.dom.Document doc, org.w3c.dom.Element element)
  
  Read from DOM
  
  Specified by:
  
  readFromDOM in interface FwkDOMHandlerInterface
  - writeConstructor
    
    public org.w3c.dom.Element writeConstructor(org.w3c.dom.Document document, FwkXmlDtdInterface dtd, org.w3c.dom.Node node, java.util.Map classProperties)
    
    Write a construtor dom node.
    
    Specified by:
    
    writeConstructor in interface FwkDOMHandlerInterface
    
    Parameters:
    document - The documnent Object Model.
    dtd - The dtd descriptor.
    node - The node.
    classProperties - Map the contains the writable object properties. May be null.
    
    Returns:
    the create document element.
  - writeToDOM
    
    public org.w3c.dom.Element writeToDOM(org.w3c.dom.Document document, FwkXmlDtdInterface dtd, org.w3c.dom.Node node, java.util.Map classProperties)
    
    Write the container as child to the given DOM node.
    
    Specified by:
    
    writeToDOM in interface FwkDOMHandlerInterface
    
    Parameters:
    document - The documnent Object Model.
    node - The parent node.
    classProperties - Map the contains the writable object properties. May be null.
    
    Returns:
    The create document element.
  writeToXML
  
  public boolean writeToXML(java.lang.String filename, boolean validate)
  
  Writes the canvas to an XML file.
  
  Specified by:
  
  writeToXML in interface FwkDOMHandlerInterface
  
  Parameters:
  filename - The name of the xml file.
  validate - Write a validated cml file.
  
  readingDOM
  
  public void readingDOM(boolean flag)
  
  Set a flag that the object is currently reading the DOM.
  
  Specified by:
  
  readingDOM in interface FwkDOMHandlerInterface
  
  Parameters:
  flag - true if the object reads currently fom DOM.
  
  readingDOM
  
  public boolean readingDOM()
  
  Get the DOM reading flag.
  
  Specified by:
  
  readingDOM in interface FwkDOMHandlerInterface
  
  Returns:
  true if the object reads currently fom DOM.
  
  visibleKey
  
  public java.lang.String visibleKey()
  
  Return the key for visible.
  
  Specified by:
  
  visibleKey in interface OdsxFilterInterface
  
  Returns:
  the visible key.
  
  enableKey
  
  public java.lang.String enableKey()
  
  Return the key for enable.
  
  Specified by:
  
  enableKey in interface OdsxFilterInterface
  
  Returns:
  the enable key.
  
  valueKey
  
  public java.lang.String valueKey()
  
  Return the value key.
  
  Specified by:
  
  valueKey in interface OdsxFilterInterface
  
  Parameters:
  the - value key.
  
  nameKey
  
  public java.lang.String nameKey()
  
  Return the name key.
  
  Specified by:
  
  nameKey in interface OdsxFilterInterface
  
  Parameters:
  the - name key.
  
  isEditable
  
  public boolean isEditable(java.lang.String key)
  
  Is the given key editable.
  
  Specified by:
  
  isEditable in interface OdsxFilterInterface
  
  Returns:
  true if the given key is editable.
  
  toString
  
  public java.lang.String toString()
  
  The to string method.
  
  Overrides:
  
  toString in class FwkCommand
  
  Returns:
  The repesentation string.

Class OdsxFilter

Field Summary

Fields inherited from class com.highqsoft.fwk.FwkCommand

Fields inherited from class com.highqsoft.fwk.FwkPropertyChange

Fields inherited from class com.highqsoft.fwk.FwkDescription

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

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

Constructor Summary

Method Summary

Methods inherited from class com.highqsoft.fwk.FwkCommand

Methods inherited from class com.highqsoft.fwk.FwkPropertyChange

Methods inherited from class com.highqsoft.fwk.FwkDescription

Methods inherited from class com.highqsoft.fwk.Fwk

Methods inherited from class java.lang.Object

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

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

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

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

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

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

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

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

Methods inherited from interface java.awt.datatransfer.Transferable

Methods inherited from interface java.awt.datatransfer.ClipboardOwner

Field Detail

PREFS_ENABLED

DEFAULT_COLOR

INSTANCE_ELEMENT_COLOR

APPLICATION_ELEMENT_COLOR

COLUMN_COLOR

BASEELEMENTMAP_NAME

NAMEVALUEMAP_NAME

APPLICATIONATTRIBUTE

APPLICATIONELEMENT

INSTANCEELEMENT

INSTANCEATTRIBUTE

BASEELEMENT

BASEATTRIBUTE

VISIBLE

ENABLED

NAME

VALUE

version

descriptor

readingDOM

enabled

instanceElementEnabled

applicationElementEnabled

valuePropGroup

url

recursiveApplStruct

Constructor Detail

OdsxFilter

OdsxFilter

Method Detail

getVersion

getDescriptor

clone

clone

getPropertyGroup

getCommands

getText

setEnabled

getEnabled

isEnabled

isEnabled

setEnableInstanceElements

getEnableInstanceElements

setEnableApplicationElements

getEnableApplicationElements

isVisible

isVisible

getGroupForKey

createGroupForKey

getGroupForElement

createGroupForElement

getIcon

setIcon

getColor

setColor