org.povclipse2.actionsets.render.settings.tree

Class AbstractConfigurationTree

java.lang.Object

org.povclipse2.actionsets.render.settings.tree.AbstractConfigurationTree

All Implemented Interfaces:

IConfigurationTree

Direct Known Subclasses:

ConfigurationTemplateTree, ConfigurationTree

public abstract class AbstractConfigurationTree
extends java.lang.Object
implements IConfigurationTree

Abstract implementation of an tree interface for managing render configurations or render configuration templates.

Author:

Wolfgang Möstl

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MENU_ITEM_DATA_TREE
protected TreeItem	rootItem

Constructor Summary

Constructors

Constructor and Description
AbstractConfigurationTree(Composite parent, int style, SelectionListener listener) Constructor

Method Summary

Modifier and Type	Method and Description
protected abstract void	addAllRenderConfigs() Reads all render configurations and adds them to the tree's root item.
TreeItem	addItem(OldRenderConfiguration renderConfig) Creates a new TreeItem displaying the given RenderConfiguration and returns it.
void	expandFullTree() Expands the full tree down to the leaves.
protected Menu	generatePopupMenu(Shell shell, SelectionListener listener) Generates the common popup menu items: New Duplicate Delete
TreeItem	getItemByRenderConfiguration(OldRenderConfiguration renderConfig) Gets the TreeItem displaying the given RenderConfiguration.
TreeItem	getSelectedItem() Gets the selected item.
boolean	hasSelection()
abstract boolean	isTemplateTree()
void	reload() Reloads the full tree content.
void	removeItem(TreeItem item) Removes a specific TreeItem.
void	selectItem(OldRenderConfiguration renderConfig) Selects the TreeItem displaying the given RenderConfiguration.
void	setItemColor(TreeItem item, boolean isValid) Sets the TreeItem forground text color. If isValid is true black will be used, otherwise red.
void	setPopupMenuConfigEnabled(boolean enabled) Enables or disables menu entries depending on the selection state.
protected abstract void	setTreeItemIcon(TreeItem treeItem) Called to set an image icon to the TreeItem.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MENU_ITEM_DATA_TREE

public static final java.lang.String MENU_ITEM_DATA_TREE

See Also:

Constant Field Values

rootItem

protected TreeItem rootItem

Constructor Detail

AbstractConfigurationTree

public AbstractConfigurationTree(Composite parent,
                                 int style,
                                 SelectionListener listener)

Constructor

Parameters:

parent - The parent Composite.

style - The widget style bits.

listener - The lestner to receive the tree selection eventes.

Method Detail

addAllRenderConfigs

protected abstract void addAllRenderConfigs()

Reads all render configurations and adds them to the tree's root item.

isTemplateTree

public abstract boolean isTemplateTree()

Specified by:

isTemplateTree in interface IConfigurationTree

Returns:

true if the tree is used for managing render configuration templates, false if it manages regular render configurations.

See Also:

com.wm.povclipse.actionsets.render.settings.tree.IConfigurationTree#isTemplateTree()

setTreeItemIcon

protected abstract void setTreeItemIcon(TreeItem treeItem)

Called to set an image icon to the TreeItem.

Parameters:

treeItem -

generatePopupMenu

protected Menu generatePopupMenu(Shell shell,
                                 SelectionListener listener)

Generates the common popup menu items:

• New
• Duplicate
• Delete

Parameters:

shell - The shell to be used for the produced Menu object.

listener - The SelectionListener to be used by the menu items.

Returns:

The produced Menu holding the MenuItem object mentioned above.

reload

public void reload()

Reloads the full tree content.

Specified by:

reload in interface IConfigurationTree

See Also:

com.wm.povclipse.actionsets.render.settings.tree.IConfigurationTree#reload()

hasSelection

public boolean hasSelection()

Returns:

true if the tree has a selection, false otherwise.

addItem

public TreeItem addItem(OldRenderConfiguration renderConfig)

Creates a new TreeItem displaying the given RenderConfiguration and returns it.

Specified by:

addItem in interface IConfigurationTree

Parameters:

renderConfig - The RenderConfiguration to be displayed.

Returns:

The new generated TreeItem.

See Also:

com.wm.povclipse.actionsets.render.settings.tree.IConfigurationTree#addItem(com.OldRenderConfiguration.povclipse.actionsets.render.RenderConfiguration)

setPopupMenuConfigEnabled

public void setPopupMenuConfigEnabled(boolean enabled)

Description copied from interface: IConfigurationTree

Enables or disables menu entries depending on the selection state.

Specified by:

setPopupMenuConfigEnabled in interface IConfigurationTree

Parameters:

enabled - true to enable the "Delete" and "Duplicate" menu items.

See Also:

com.wm.povclipse.actionsets.render.settings.tree.IConfigurationTree#setPopupMenuConfigEnabled(boolean)

getSelectedItem

public TreeItem getSelectedItem()

Gets the selected item.

Specified by:

getSelectedItem in interface IConfigurationTree

Returns:

The selected TreeItem or NULL if no item is selected.

See Also:

com.wm.povclipse.actionsets.render.settings.tree.IConfigurationTree#getSelectedItem()

getItemByRenderConfiguration

public TreeItem getItemByRenderConfiguration(OldRenderConfiguration renderConfig)

Gets the TreeItem displaying the given RenderConfiguration.

Specified by:

getItemByRenderConfiguration in interface IConfigurationTree

Parameters:

renderConfig - The RenderConfiguration to be searched for.

Returns:

The TreeItem displaying the given RenderConfiguration or null if none can be found.

See Also:

com.wm.povclipse.actionsets.render.settings.tree.IConfigurationTree#getItemByRenderConfiguration(com.OldRenderConfiguration.povclipse.actionsets.render.RenderConfiguration)

selectItem

public void selectItem(OldRenderConfiguration renderConfig)

Description copied from interface: IConfigurationTree

Selects the TreeItem displaying the given RenderConfiguration.

Specified by:

selectItem in interface IConfigurationTree

Parameters:

renderConfig - The RenderConfiguration to be looked for.

See Also:

com.wm.povclipse.actionsets.render.settings.tree.IConfigurationTree#selectItem(com.OldRenderConfiguration.povclipse.actionsets.render.RenderConfiguration)

removeItem

public void removeItem(TreeItem item)

Description copied from interface: IConfigurationTree

Removes a specific TreeItem.

Specified by:

removeItem in interface IConfigurationTree

Parameters:

item - The TreeItem to be removed.

See Also:

com.wm.povclipse.actionsets.render.settings.tree.IConfigurationTree#removeItem(org.eclipse.swt.widgets.TreeItem)

setItemColor

public void setItemColor(TreeItem item,
                         boolean isValid)

Description copied from interface: IConfigurationTree

Sets the TreeItem forground text color.
If isValid is true black will be used, otherwise red.

Specified by:

setItemColor in interface IConfigurationTree

Parameters:

item - The TreeItem to be colored.

isValid - true to use black, false to use red.

See Also:

com.wm.povclipse.actionsets.render.settings.tree.IConfigurationTree#setItemColor(org.eclipse.swt.widgets.TreeItem, boolean)

expandFullTree

public void expandFullTree()

Expands the full tree down to the leaves.