Class InteractiveUIContent
- java.lang.Object
-
- org.eclipse.emf.compare.rcp.ui.internal.preferences.impl.InteractiveUIContent
-
public final class InteractiveUIContent extends Object
A User interface that holds a viewer and satellites elements.This viewer can have a satellite configuration composite reacting on selection. It displays a configuration UI for the current selection. It's requires a configuration UI registry.
This viewer can have a satellite text field holding the description of the current selection. This field display the description for the current element.
This class allows a user to select and check elements.
It can also synchronize the state of checked element into a
DataHolder
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classInteractiveUIContent.InteractiveUIBuilder<T>Builder for an Interactive UI.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddConfigurator(String id, IConfigurationUIFactory configuratorfactory, org.eclipse.jface.preference.IPreferenceStore store)Adds a configuration to this Interactive content.voidcheckElement(IItemDescriptor<?> descriptor)Checks one element in the viewer.<T> voidcheckElements(Collection<IItemDescriptor<T>> descriptors)Checks multiple element in the viewer.<T> voidcheckElements(IItemDescriptor<T>[] descriptors)Checks multiple element in the viewer.Map<String,AbstractConfigurationUI>getConfigurators()org.eclipse.jface.viewers.CheckboxTableViewergetViewer()Gets the viewer.<T> voidselect(IItemDescriptor<T> descriptor)Handles a selection in the viewer.<T> voidselectAll(Collection<IItemDescriptor<T>> descriptors)Handles a selection in the viewer.voidsetViewer(org.eclipse.jface.viewers.CheckboxTableViewer inputViewer)Sets the viewer in the interactive content.
-
-
-
Method Detail
-
addConfigurator
public void addConfigurator(String id, IConfigurationUIFactory configuratorfactory, org.eclipse.jface.preference.IPreferenceStore store)
Adds a configuration to this Interactive content.- Parameters:
id- Id of the item to configureconfiguratorfactory- Factory for the configurationstore- Preference store that will hold thisIConfigurationUIFactoryvalue.
-
checkElement
public void checkElement(IItemDescriptor<?> descriptor)
Checks one element in the viewer.- Parameters:
descriptor- element to check.
-
checkElements
public <T> void checkElements(Collection<IItemDescriptor<T>> descriptors)
Checks multiple element in the viewer. (Only use if multiple selection is allowed)- Parameters:
descriptors- elements to check.
-
checkElements
public <T> void checkElements(IItemDescriptor<T>[] descriptors)
Checks multiple element in the viewer. (Only use if multiple selection is allowed)- Parameters:
descriptors- elements to check.
-
getConfigurators
public Map<String,AbstractConfigurationUI> getConfigurators()
- Returns:
- A map of all configuration.
-
getViewer
public org.eclipse.jface.viewers.CheckboxTableViewer getViewer()
Gets the viewer.- Returns:
- The viewer.
-
select
public <T> void select(IItemDescriptor<T> descriptor)
Handles a selection in the viewer. Update related components.- Parameters:
descriptor- Item to select.
-
selectAll
public <T> void selectAll(Collection<IItemDescriptor<T>> descriptors)
Handles a selection in the viewer. Update related components.- Parameters:
descriptor- Item to select.
-
setViewer
public void setViewer(org.eclipse.jface.viewers.CheckboxTableViewer inputViewer)
Sets the viewer in the interactive content.- Parameters:
inputViewer- AStructuredViewerofIItemDescriptor
-
-