org.povclipse2.actionsets.render.settings.tree

Interface IConfigurationTree

All Known Implementing Classes:

AbstractConfigurationTree, ConfigurationTemplateTree, ConfigurationTree

public interface IConfigurationTree

Interface for widgets handling render configuration trees.

Author:

Wolfgang Möstl

Method Summary

Modifier and Type	Method and Description
TreeItem	addItem(OldRenderConfiguration renderConfig) Adds a new TreeItem displaying the given RenderConfiguration and returns it.
TreeItem	getItemByRenderConfiguration(OldRenderConfiguration renderConfig) Gets the TreeItem displaying the given RenderConfiguration.
TreeItem	getSelectedItem() Gets the selected item.
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.

Method Detail

getSelectedItem

TreeItem getSelectedItem()

Gets the selected item.

Returns:

The selected TreeItem or NULL if no item is selected.

selectItem

void selectItem(OldRenderConfiguration renderConfig)

Selects the TreeItem displaying the given RenderConfiguration.

Parameters:

renderConfig - The RenderConfiguration to be looked for.

addItem

TreeItem addItem(OldRenderConfiguration renderConfig)

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

Parameters:

renderConfig - The RenderConfiguration to be displayed.

Returns:

The new generated TreeItem.

removeItem

void removeItem(TreeItem item)

Removes a specific TreeItem.

Parameters:

item - The TreeItem to be removed.

isTemplateTree

boolean isTemplateTree()

Returns:

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

setItemColor

void setItemColor(TreeItem item,
                  boolean isValid)

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

Parameters:

item - The TreeItem to be colored.

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

reload

void reload()

Reloads the full tree content.

setPopupMenuConfigEnabled

void setPopupMenuConfigEnabled(boolean enabled)

Enables or disables menu entries depending on the selection state.

Parameters:

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

getItemByRenderConfiguration

TreeItem getItemByRenderConfiguration(OldRenderConfiguration renderConfig)

Gets the TreeItem displaying the given RenderConfiguration.

Parameters:

renderConfig - The RenderConfiguration to be searched for.

Returns:

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