com.highqsoft.interfaces.odsx

Interface OdsxSelectorTreeNodeInterface

All Superinterfaces:

java.awt.datatransfer.ClipboardOwner, java.lang.Comparable, java.util.EventListener, FwkDescriptionInterface, FwkInstructionInterface, FwkInterface, FwkPresentationInterface, FwkPropertyChangeInterface, FwkPropertyChangeListenerInterface, FwkTransferableInterface, javax.swing.tree.MutableTreeNode, java.beans.PropertyChangeListener, java.io.Serializable, java.awt.datatransfer.Transferable, javax.swing.tree.TreeNode

All Known Implementing Classes:

OdsxFilteredTreeNode

public interface OdsxSelectorTreeNodeInterface
extends FwkInstructionInterface, javax.swing.tree.MutableTreeNode, java.lang.Comparable, FwkPropertyChangeInterface, FwkPropertyChangeListenerInterface, FwkDescriptionInterface

The OdsxSelectorTreeNodeInterface is the interface for ASAM-ODS navigation selector node.

Since:

$Date: 2017/04/06 13:29:48 $

Version:

$Revision: 1.13 $

Author:

Andreas Hofmann

See Also:

Field Summary

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	delete(boolean flag) Delete a node.
int	getChildIndexByPath(javax.swing.tree.TreePath path) Get child index by path
java.awt.Color	getColor() Get the color of the item.
OdsxFilterInterface	getFilter() Retrieve the actual filter.
OdsxPresentableElementInterface	getPresentableElement() Get the user object.
java.lang.String	getTranslatedName() Returns the filtered name of the element.
boolean	isApplicationElement() Return a boolean whether the node implements OdsxApplicationElementInterface.
boolean	isColumn() Return a boolean whether the node implements OdsxColumnInterface.
boolean	isEnabled() Check if the element is enabled by this filter.
boolean	isInstanceElement() Return a boolean whether the node implements OdsxInstanceElementInterface.
boolean	isLeaf() Return whether the current node is a leaf.
boolean	isSessionElement() Return a boolean whether the node implements OdsxSessionElementInterface.
boolean	isVisible() Check if the element is visible by this filter.
void	reloadChildren() Reload the children.
void	reloadChildren(boolean force) Reload the children.
void	setColor(java.awt.Color color) Set the color of the item.
void	setFilter(OdsxFilterInterface filter) Set a filter.
void	setFilter(OdsxFilterInterface odsFilter, boolean flag) Sets the ods filter for this node.
void	setPresentableElement(OdsxPresentableElementInterface elem) Set the user object.
void	setTranslatedName(java.lang.String value) Returns the filtered name of the element.
void	setVisible(boolean flag) Set the visibility of the node.
void	updateNode() Update the node.

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.swing.tree.MutableTreeNode

insert, remove, remove, removeFromParent, setParent, setUserObject

Methods inherited from interface javax.swing.tree.TreeNode

children, getAllowsChildren, getChildAt, getChildCount, getIndex, getParent

Methods inherited from interface java.lang.Comparable

compareTo

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 java.beans.PropertyChangeListener

propertyChange

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

Method Detail

setColor

void setColor(java.awt.Color color)

Set the color of the item.

Parameters:

color - The new color of the element.

getColor

java.awt.Color getColor()

Get the color of the item.

Returns:

The current solor of the element.

isEnabled

boolean isEnabled()

Check if the element is enabled by this filter.

Returns:

True if the element passes the filter.

isVisible

boolean isVisible()

Check if the element is visible by this filter.

Returns:

True if the element is visible.

setVisible

void setVisible(boolean flag)

Set the visibility of the node.

Parameters:

flag - true if the node should be visible.

isInstanceElement

boolean isInstanceElement()

Return a boolean whether the node implements OdsxInstanceElementInterface.

Returns:

true if the node is an instance element.

isApplicationElement

boolean isApplicationElement()

Return a boolean whether the node implements OdsxApplicationElementInterface.

Returns:

true if the node is an application element.

isSessionElement

boolean isSessionElement()

Return a boolean whether the node implements OdsxSessionElementInterface.

Returns:

true if the node is a session.

isColumn

boolean isColumn()

Return a boolean whether the node implements OdsxColumnInterface.

Returns:

true if the node is an application element.

getPresentableElement

OdsxPresentableElementInterface getPresentableElement()

Get the user object.

Returns:

The user object.

setPresentableElement

void setPresentableElement(OdsxPresentableElementInterface elem)

Set the user object.

Parameters:

elem - The user object.

setFilter

void setFilter(OdsxFilterInterface filter)

Set a filter.

Parameters:

filter - The filter.

setFilter

void setFilter(OdsxFilterInterface odsFilter,
             boolean flag)

Sets the ods filter for this node.

Parameters:

filter - the ods filter.

flag - if true the filter will be set recurtsivly.

See Also:

getFilter()

getFilter

OdsxFilterInterface getFilter()

Retrieve the actual filter.

Returns:

The filter (may be null).

setTranslatedName

void setTranslatedName(java.lang.String value)

Returns the filtered name of the element.

Parameters:

value - The new translated name of the element.

getTranslatedName

java.lang.String getTranslatedName()

Returns the filtered name of the element.

Returns:

The filtered name value.

isLeaf

boolean isLeaf()

Return whether the current node is a leaf. This value is always false until the loading of children fails.

Specified by:

isLeaf in interface javax.swing.tree.TreeNode

Returns:

isLeaf The flag indicating if the current node is a leaf.

reloadChildren

void reloadChildren(boolean force)

Reload the children.

Parameters:

force - if true the loading will be done in every case.

updateNode

void updateNode()

Update the node.

reloadChildren

void reloadChildren()

Reload the children.

delete

void delete(boolean flag)

Delete a node.

Parameters:

flag - true if the element should be deleted with references.

getChildIndexByPath

int getChildIndexByPath(javax.swing.tree.TreePath path)

Get child index by path

Returns:

the child index by given the path of the child.