info.bioinfweb.tic.scrolling

Class ScrollingTICComponent

java.lang.Object

info.bioinfweb.tic.TICComponent

info.bioinfweb.tic.scrolling.ScrollingTICComponent

public abstract class ScrollingTICComponent
extends TICComponent

All TIC components that contain scrolled content should be inherited from this class. It offer toolkit-independent methods to control and manipulate the scroll position.

Note that getSwingComponentClassName(Object...) and getSWTComponentClassName(Object...) must be overwritten to return names of classes that implement ScrollingToolkitComponent. The default implementations of this class throw an UnsupportedToolkitException.

Since:

3.0.0

Author:

Ben Stöver

Field Summary

Fields inherited from class info.bioinfweb.tic.TICComponent

DISPATCHER_MAP, repaintRequested

Constructor Summary

Constructors

Constructor and Description
ScrollingTICComponent()

Method Summary

Modifier and Type	Method and Description
void	fireControlScrolled(TICScrollEvent event) Informs all listeners that the contained component was scrolled.
java.util.Set<TICScrollListener>	getScrollListeners() Returns an editable set of scroll listeners that will be notified by on scroll events happening within this component.
int	getScrollOffsetX() Returns the current painting offset on x.
int	getScrollOffsetY() Returns the current painting offset on y.
protected java.lang.String	getSwingComponentClassName(java.lang.Object... parameters) Throws an UnsupportedToolkitException.
protected java.lang.String	getSWTComponentClassName(java.lang.Object... parameters) Throws an UnsupportedToolkitException.
ScrollingToolkitComponent	getToolkitComponent() Returns a toolkit specific component used to display the contents of this class.
java.awt.Rectangle	getVisibleRectangle() Returns the rectangle in the coordinate system of the scrolled component that is currently visible.
void	scrollRectangleToVisible(java.awt.geom.Rectangle2D rectangle) Scrolls the contained component so that the specified rectangle of that component is visible.
void	setScrollOffset(int x, int y) Sets the current painting offset on x and y.
void	setScrollOffsetX(int x) Sets the current painting offset on x.
void	setScrollOffsetY(int y) Sets the current painting offset on y.

Methods inherited from class info.bioinfweb.tic.TICComponent

addKeyListener, addMouseListener, addMouseWheelListener, assignSize, dispatchEvent, getCurrentToolkit, getKeyListenersSet, getMouseListenersSet, getMouseWheelListenersSet, getSize, getSwingComponentConstructorParameters, getSWTComponentConstructorParameters, hasDefinedSize, hasToolkitComponent, isUpdateOngoing, paint, removeKeyListener, removeMouseListener, removeWheelMouseListener, repaint, setToolkitComponent, setUpdateOngoing

Methods inherited from class java.lang.Object

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

Constructor Detail

ScrollingTICComponent

public ScrollingTICComponent()

Method Detail

getToolkitComponent

public ScrollingToolkitComponent getToolkitComponent()

Description copied from class: TICComponent

Returns a toolkit specific component used to display the contents of this class.

Overrides:

getToolkitComponent in class TICComponent

Returns:

the toolkit specific component or null if neither a Swing nor a SWT component has yet been created

getSwingComponentClassName

protected java.lang.String getSwingComponentClassName(java.lang.Object... parameters)

Throws an UnsupportedToolkitException. Inherited classes should overwrite this method to provide a Swing toolkit component that implements ScrollingToolkitComponent.

Overrides:

getSwingComponentClassName in class TICComponent

Parameters:

parameters - an optional list of parameters that were passed to the getSwingComponent() method of SwingComponentFactory

Returns:

a fully qualified class name for a class used to create the concrete Swing GUI instance associated with this instance

getSWTComponentClassName

protected java.lang.String getSWTComponentClassName(java.lang.Object... parameters)

Throws an UnsupportedToolkitException. Inherited classes should overwrite this method to provide an SWT toolkit component that implements ScrollingToolkitComponent.

Overrides:

getSWTComponentClassName in class TICComponent

Parameters:

parameters - an optional list of parameters that were passed to the getSWTComponent() method of SWTComponentFactory

Returns:

a fully qualified class name for a class used to create the concrete SWT GUI instance associated with this instance

setScrollOffset

public void setScrollOffset(int x,
                            int y)

Sets the current painting offset on x and y. This method should be used, if both coordinates are changed, instead of calling setScrollOffsetX(int) and setScrollOffsetY(int) separately to avoid unnecessary repainting.

If no toolkit component has yet been created, calling this method will have no effect.

Parameters:

x - the new shift of the painting coordinate origin on x

y - the new shift of the painting coordinate origin on y

setScrollOffsetX

public void setScrollOffsetX(int x)

Sets the current painting offset on x. If this property is e.g. set 10, the component will be painted as if it would be scrolled to the right by 10 px. (The left-most 10 px are not visible.)

If no toolkit component has yet been created, calling this method will have no effect.

Parameters:

scrollOffsetX - the new shift of the painting coordinate origin on x

setScrollOffsetY

public void setScrollOffsetY(int y)

Sets the current painting offset on y. If this property is e.g. set 10, the component will be painted as if it would be scrolled downwards by 10 px. (The top-most 10 px are not visible.)

If no toolkit component has yet been created, calling this method will have no effect.

Parameters:

y - the new shift of the painting coordinate origin on y

getScrollOffsetX

public int getScrollOffsetX()

Returns the current painting offset on x. If this property is e.g. set 10, the component will be painted as if it would be scrolled to the right by 10 px. (The left-most 10 px are not visible.)

Returns:

the shift of the painting coordinate origin on x

getScrollOffsetY

public int getScrollOffsetY()

Returns the current painting offset on y. If this property is e.g. set 10, the component will be painted as if it would be scrolled downwards by 10 px. (The top-most 10 px are not visible.)

Returns:

the shift of the painting coordinate origin on y

scrollRectangleToVisible

public void scrollRectangleToVisible(java.awt.geom.Rectangle2D rectangle)

Scrolls the contained component so that the specified rectangle of that component is visible. If the rectangle is already fully visible, no scrolling will be performed.

Parameters:

rectangle - the rectangle that shall become fully visible

getVisibleRectangle

public java.awt.Rectangle getVisibleRectangle()

Returns the rectangle in the coordinate system of the scrolled component that is currently visible.

Returns:

the currently visible rectangle

getScrollListeners

public java.util.Set<TICScrollListener> getScrollListeners()

Returns an editable set of scroll listeners that will be notified by on scroll events happening within this component.

Returns:

the set of registered scroll listeners

fireControlScrolled

public void fireControlScrolled(TICScrollEvent event)

Informs all listeners that the contained component was scrolled.

This method is meant to be called by scrolling toolkit components. Application will not have to call this method directly, unless it implements custom scrolling toolkit components.

Parameters:

event - the object describing the scroll event