info.bioinfweb.commons.swt

Class ScrolledCompositeSyncListener

java.lang.Object

info.bioinfweb.commons.swt.ScrolledCompositeSyncListener

public class ScrolledCompositeSyncListener
extends java.lang.Object

Selection listener that synchronizes ScrolledComposite components in horizontal or vertical direction. Both the ScrolledComposites as well as their content areas need to have the same lengths in the selected direction.

Author:

Ben Stöver

Module:

info.bioinfweb.commons.swt

Constructor Summary

Constructors

Constructor and Description
ScrolledCompositeSyncListener(java.util.Collection<org.eclipse.swt.custom.ScrolledComposite> scrolledComposites, boolean horizontal) Creates a new instance of this class which uses a deep copy of scrolledComposites.
ScrolledCompositeSyncListener(org.eclipse.swt.custom.ScrolledComposite[] scrolledComposites, boolean horizontal) Creates a new instance of this class which uses a deep copy of scrolledComposites.

Method Summary

Modifier and Type	Method and Description
boolean	isHorizontal()
boolean	isVertical()
static ScrolledCompositeSyncListener	newLinkedInstance(java.lang.Iterable<org.eclipse.swt.custom.ScrolledComposite> scrolledComposites, boolean horizontal) Creates a new instance of this class that uses the specified collection as the source.
void	registerToAll() Registers this object as the selection listener at all according scroll bars of the specified ScrolledComposites.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScrolledCompositeSyncListener

public ScrolledCompositeSyncListener(java.util.Collection<org.eclipse.swt.custom.ScrolledComposite> scrolledComposites,
                                     boolean horizontal)

Creates a new instance of this class which uses a deep copy of scrolledComposites. That means future changes to scrolledComposites will not be reflected by this instance. If you need this functionality use newLinkedInstance(Iterable, boolean) instead.

Note that all ScrolledComposites need to have a scroll bar in the according direction. Otherwise a NullPointerException will occur.

Parameters:

scrolledComposites - the scroll components to be synchronized

horizontal - Specify true here of you want to synchronize horizontal scrolling or false for vertical scrolling.

ScrolledCompositeSyncListener

public ScrolledCompositeSyncListener(org.eclipse.swt.custom.ScrolledComposite[] scrolledComposites,
                                     boolean horizontal)

Creates a new instance of this class which uses a deep copy of scrolledComposites. That means future changes to scrolledComposites will not be reflected by this instance. If you need this functionality use newLinkedInstance(Iterable, boolean) instead.

Note that all ScrolledComposites need to have a scroll bar in the according direction. Otherwise a NullPointerException will occur.

Parameters:

scrolledComposites - the scroll components to be synchronized

horizontal - Specify true here of you want to synchronize horizontal scrolling or false for vertical scrolling.

Method Detail

newLinkedInstance

public static ScrolledCompositeSyncListener newLinkedInstance(java.lang.Iterable<org.eclipse.swt.custom.ScrolledComposite> scrolledComposites,
                                                              boolean horizontal)

Creates a new instance of this class that uses the specified collection as the source. Future changes to that collection will be reflected in the behavior of the returned instance. If you do not want that use ScrolledCompositeSyncListener(Collection, boolean) instead.

Parameters:

scrolledComposites -

horizontal -

Returns:

isHorizontal

public boolean isHorizontal()

isVertical

public boolean isVertical()

registerToAll

public void registerToAll()

Registers this object as the selection listener at all according scroll bars of the specified ScrolledComposites.

This method should only be called once to avoid that this instance is registered several times as a listener for some components.