com.ibm.xtools.common.ui.reduction.viewers

Class ActivitiesCheckboxTreeWrapper

java.lang.Object

com.ibm.xtools.common.ui.reduction.viewers.ActivitiesCheckboxTreeWrapper

public class ActivitiesCheckboxTreeWrapper
extends java.lang.Object

Wraps a CheckboxTreeViewer to provide an activities specific checkbox tree control.

Constructor Summary

Constructors

Constructor and Description
ActivitiesCheckboxTreeWrapper(org.eclipse.jface.viewers.CheckboxTreeViewer checkboxTreeViewer) Initializes the check box tree viewer with activities data

Method Summary

Modifier and Type	Method and Description
void	addCheckStateListener(org.eclipse.jface.viewers.ICheckStateListener listener) Add the given listener to the list of listeners
protected void	fireCheckStateChanged(org.eclipse.jface.viewers.CheckStateChangedEvent event) Notifies any check state listeners that the check state of an element has changed.
org.eclipse.jface.viewers.CheckboxTreeViewer	getCheckboxTreeViewer() Return the wrapped CheckboxTreeViewer.
java.util.Set<java.lang.String>	getCheckedActivityIds() Returns the set of activity ids that are checked in the activity tree control
java.util.Set<java.lang.String>	getRequiredActivityIds() Returns the set of required activity ids.
java.lang.Object	getSelectedElement() Returns the first element selected in the tree control.
java.util.Set<java.lang.String>	getUncheckedActivityIds() Returns the list of activity ids that are unchecked in the activity tree control
void	linkDescriptionText(org.eclipse.swt.widgets.Text descriptionText) Adds a ISelectionChangedListener to checkbox tree viewer in order to update the given description text with the name of the selected IActivity or ICategory.
void	refresh() Refresh the tree viewer.
void	refresh(boolean showActivitiesArg) Refresh the tree viewer.
void	removeCheckStateListener(org.eclipse.jface.viewers.ICheckStateListener listener) Remove the given listener to the list of listeners
void	restoreDefaults() Restore the activities back to their default state.
void	setAllChecked(boolean state) Set all elements to the given state.
void	setEditable(boolean editable) Set the tree viewer to be editable or not.
void	setEnabled(boolean enabled) Set the enablement of the tree viewer to the given state.
void	setPrecheckedActivityIds(java.util.Set<java.lang.String> activityIds) Sets the Set of prechecked activity ids to the provided activityIds
void	setRequiredActivityIds(java.util.Set<java.lang.String> activityIds) Sets the Set of required activity ids to the provided activityIds.

Methods inherited from class java.lang.Object

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

Constructor Detail

ActivitiesCheckboxTreeWrapper

public ActivitiesCheckboxTreeWrapper(org.eclipse.jface.viewers.CheckboxTreeViewer checkboxTreeViewer)

Initializes the check box tree viewer with activities data

Parameters:

checkboxTreeViewer - the underlying checkbox tree viewer

Method Detail

getCheckboxTreeViewer

public org.eclipse.jface.viewers.CheckboxTreeViewer getCheckboxTreeViewer()

Return the wrapped CheckboxTreeViewer.

Returns:

the wrapped CheckboxTreeViewer

getSelectedElement

public java.lang.Object getSelectedElement()

Returns the first element selected in the tree control.

Returns:

the first element selected in the tree control

getCheckedActivityIds

public java.util.Set<java.lang.String> getCheckedActivityIds()

Returns the set of activity ids that are checked in the activity tree control

Returns:

set activity ids that are checked

getRequiredActivityIds

public java.util.Set<java.lang.String> getRequiredActivityIds()

Returns the set of required activity ids.

Returns:

set of required activity ids

getUncheckedActivityIds

public java.util.Set<java.lang.String> getUncheckedActivityIds()

Returns the list of activity ids that are unchecked in the activity tree control

Returns:

set activity ids that are unchecked

refresh

public void refresh()

Refresh the tree viewer.

refresh

public void refresh(boolean showActivitiesArg)

Refresh the tree viewer.

Parameters:

showActivitiesArg - true if the tree viewer should display the activities, false if the tree viewer should be empty

setRequiredActivityIds

public void setRequiredActivityIds(java.util.Set<java.lang.String> activityIds)

Sets the Set of required activity ids to the provided activityIds. Computes the activity requirement bindings for all the given required activity ids.

Parameters:

activityIds -

setPrecheckedActivityIds

public void setPrecheckedActivityIds(java.util.Set<java.lang.String> activityIds)

Sets the Set of prechecked activity ids to the provided activityIds

Parameters:

activityIds -

restoreDefaults

public void restoreDefaults()

Restore the activities back to their default state.

addCheckStateListener

public void addCheckStateListener(org.eclipse.jface.viewers.ICheckStateListener listener)

Add the given listener to the list of listeners

Parameters:

listener - listener to add

removeCheckStateListener

public void removeCheckStateListener(org.eclipse.jface.viewers.ICheckStateListener listener)

Remove the given listener to the list of listeners

Parameters:

listener - listener to remove

fireCheckStateChanged

protected void fireCheckStateChanged(org.eclipse.jface.viewers.CheckStateChangedEvent event)

Notifies any check state listeners that the check state of an element has changed. Only listeners registered at the time this method is called are notified.

Parameters:

event - a check state changed event

See Also:

ICheckStateListener.checkStateChanged(org.eclipse.jface.viewers.CheckStateChangedEvent)

setEnabled

public void setEnabled(boolean enabled)

Set the enablement of the tree viewer to the given state.

Parameters:

enabled -

setEditable

public void setEditable(boolean editable)

Set the tree viewer to be editable or not.

Parameters:

editable -

setAllChecked

public void setAllChecked(boolean state)

Set all elements to the given state.

Parameters:

state -

linkDescriptionText

public void linkDescriptionText(org.eclipse.swt.widgets.Text descriptionText)

Adds a ISelectionChangedListener to checkbox tree viewer in order to update the given description text with the name of the selected IActivity or ICategory.