Package com.iizigo.editor
Class MultiSelectionProvider
java.lang.Object
com.iizigo.editor.MultiSelectionProvider
- All Implemented Interfaces:
- EventListener,- ISelectionChangedListener,- ISelectionProvider,- CaretListener,- DisposeListener,- FocusListener,- KeyListener,- ModifyListener,- MouseListener,- SelectionListener,- SWTEventListener
public class MultiSelectionProvider extends Object implements ISelectionProvider, DisposeListener, FocusListener, ISelectionChangedListener, ModifyListener, KeyListener, MouseListener, SelectionListener, CaretListener
Class used as selection provider for a part consisting of multiple types of components that would support the selection interface.
Supported components:
- Text capable widgets: Text, Combo, CCombo, Tree, Table, etc...
- Other selection providers such as viewers.
- Constructor SummaryConstructorsConstructorDescriptionCreates the instance without a default provider.- MultiSelectionProvider- (ISelectionProvider defaultProvider) Creates the instance with a default provider.
- Method SummaryModifier and TypeMethodDescription- void- addComposite- (Composite composite, ISelectionProvider selectionProvider) Adds a composite that is part of the selection process.- void- addControl- (Control control) Adds a control that is part of the selection process.- void- addControl- (Control control, ISelectionProvider selectionProvider) Adds a control that is part of the selection process.- voidAdds a listener for selection changes in this selection provider.- void- caretMoved- (CaretEvent event) This method is called after the caret offset is changed.- void- dispose()Disposes of the selection provider.- voidFires the current selection to the listeners.- void- fireSelection- (ISelection selection) Fires the selection to the listeners.- voidFires the selection asynchronously.- voidFocus gained.- voidFocus lost.Gets the current IClipboardSelection interface for the current control.Gets the current control.Returns the current selection for this provider.- static TextViewer- getTextViewer- (StyledText styledText) Gets the text viewer for a StyledText control.- void- void- voidEntry field control modification.- void- void- void- voidDrag finished, called by the part when all drags complete.- void- onPartActivated- (boolean isActive) Clears the current focus control due to part inactivation.- static void- registerViewer- (TextViewer viewer) Registers the TextViewer or similar (e.g.- void- removeControl- (Control control, boolean fireEventIfFocusLost) Removes a control that was part of the selection process.- voidRemoves the given selection change listener from this selection provider.- voidNotifies that the selection has changed.- void- setDefaultProvider- (ISelectionProvider defaultProvider) Sets the default provider when no provider is found for a control.- void- setDraggingFix- (IDraggingFix dragFixer) Sets the dragging fix interface.- voidMarks the selection provider as initialized on the owner side, i.e.- void- setSelection- (ISelection selection) Sets the current selection for this selection provider.- voidSent when default selection occurs in the control.- voidCalled when a widget is disposed of.- voidSent when selection occurs in the control.
- Constructor Details- MultiSelectionProviderpublic MultiSelectionProvider()Creates the instance without a default provider.
- MultiSelectionProviderCreates the instance with a default provider.
 
- Method Details- registerViewerRegisters the TextViewer or similar (e.g. SourceViewer) as the controller class for it's StyledText. This is used to be able to extract the viewer for the MultiSelectionProvider and the IIZI actions for undo/redo, clipboard, etc...
- getTextViewerGets the text viewer for a StyledText control.- Parameters:
- styledText- The styled text control.
- Returns:
- The text viewer, or null for none.
 
- setDefaultProviderSets the default provider when no provider is found for a control.
- disposepublic void dispose()Disposes of the selection provider.
- setDraggingFixSets the dragging fix interface.
- onDragEndpublic void onDragEnd()Drag finished, called by the part when all drags complete.
- setInitializedpublic void setInitialized()Marks the selection provider as initialized on the owner side, i.e. that all controls, etc, are created and that selection events should be sent.
- onPartActivatedpublic void onPartActivated- (boolean isActive) Clears the current focus control due to part inactivation.
- addCompositeAdds a composite that is part of the selection process.- Recursion will be done to find all Text, Combo, CCombo, StyledText, Spinner, then special clipboard routines also applies. - Parameters:
- composite- The composite.
- selectionProvider- The selection provider to use.
 
- addControlAdds a control that is part of the selection process.- If the control is Text, Combo, CCombo, StyledText, Spinner, then special clipboard routines also applies. - Parameters:
- control- The control.
 
- addControlAdds a control that is part of the selection process.- Parameters:
- control- The control.
- selectionProvider- Potential selection provider (e.g. the Viewer for Tree or Table).- If the - selectionProviderimplements the interface- IClipboardSelectionthis interface can be returned with the method- getClipboardSelectionProvider().
 
- widgetDisposedCalled when a widget is disposed of.- Specified by:
- widgetDisposedin interface- DisposeListener
 
- removeControlRemoves a control that was part of the selection process.- Parameters:
- control- The control.
 
- addSelectionChangedListenerAdds a listener for selection changes in this selection provider. Has no effect if an identical listener is already registered.- Specified by:
- addSelectionChangedListenerin interface- ISelectionProvider
- Parameters:
- listener- A selection changed listener.
 
- removeSelectionChangedListenerRemoves the given selection change listener from this selection provider. Has no effect if an identical listener is not registered.- Specified by:
- removeSelectionChangedListenerin interface- ISelectionProvider
- Parameters:
- listener- A selection changed listener.
 
- selectionChangedNotifies that the selection has changed. Called by Structured Viewers due to added controls. This will fire a selection change to all listeners, when potential dragging is completed.- Specified by:
- selectionChangedin interface- ISelectionChangedListener
- Parameters:
- event- Event object describing the change.
 
- fireCurrentSelectionpublic void fireCurrentSelection()Fires the current selection to the listeners.
- fireSelectionFires the selection to the listeners.
- getSelectionReturns the current selection for this provider.- Specified by:
- getSelectionin interface- ISelectionProvider
- Returns:
- The current selection.
 
- setSelectionSets the current selection for this selection provider.- Specified by:
- setSelectionin interface- ISelectionProvider
- Parameters:
- selection- the new selection
 
- focusGainedFocus gained.- Specified by:
- focusGainedin interface- FocusListener
 
- focusLostFocus lost.- Specified by:
- focusLostin interface- FocusListener
 
- getClipboardSelectionProviderGets the current IClipboardSelection interface for the current control.- Returns:
- null If not available.
 
- getCurrentControlGets the current control.- Returns:
- The control in focus, or null for none.
 
- modifyTextEntry field control modification.- Specified by:
- modifyTextin interface- ModifyListener
 
- widgetSelectedSent when selection occurs in the control.- Specified by:
- widgetSelectedin interface- SelectionListener
- Parameters:
- e- An event containing information about the selection.
 
- widgetDefaultSelectedSent when default selection occurs in the control.- Specified by:
- widgetDefaultSelectedin interface- SelectionListener
- Parameters:
- e- An event containing information about the default selection.
 
- caretMovedThis method is called after the caret offset is changed.- Specified by:
- caretMovedin interface- CaretListener
- Parameters:
- event- The given event.
- See Also:
 
- fireSelectionAsyncpublic void fireSelectionAsync()Fires the selection asynchronously. The selection is fired only once, even if called multiple times within the same "sync" call (if from called from the SWT thread).
- mouseDoubleClick- Specified by:
- mouseDoubleClickin interface- MouseListener
 
- mouseDown- Specified by:
- mouseDownin interface- MouseListener
 
- mouseUp- Specified by:
- mouseUpin interface- MouseListener
 
- keyPressed- Specified by:
- keyPressedin interface- KeyListener
 
- keyReleased- Specified by:
- keyReleasedin interface- KeyListener