org.eclipse.nebula.widgets.carousel

Class Carousel

java.lang.Object

org.eclipse.swt.widgets.Widget

org.eclipse.swt.widgets.Control

org.eclipse.swt.widgets.Scrollable

org.eclipse.swt.widgets.Composite

org.eclipse.nebula.widgets.carousel.Carousel

All Implemented Interfaces:

org.eclipse.swt.graphics.Drawable

public class Carousel
extends org.eclipse.swt.widgets.Composite

Instances of this class represent a "Carousel". This is a component that displays numerous images, and ones can navigate through images.

Styles:

(none)

Events:

SWT.Selection

Field Summary

Fields

Modifier and Type	Field and Description
(package private) ImageContainer	imageContainer
(package private) ImageSelector	imageSelector
(package private) int	selection
(package private) java.util.List<org.eclipse.swt.events.SelectionListener>	selectionListeners

Fields inherited from class org.eclipse.swt.widgets.Control

handle

Constructor Summary

Constructors

Constructor and Description
Carousel(org.eclipse.swt.widgets.Composite parent, int style) Constructs a new instance of this class given its parent and a style value describing its behavior and appearance.

Method Summary

Modifier and Type	Method and Description
void	addImage(org.eclipse.swt.graphics.Image image) Adds the image to the collection of images
void	addListener(int eventType, org.eclipse.swt.widgets.Listener listener)
void	addSelectionListener(org.eclipse.swt.events.SelectionListener listener) Adds the listener to the collection of listeners who will be notified when the control is selected by the user, by sending it one of the messages defined in the SelectionListener interface.
org.eclipse.swt.graphics.Color	getArrowColor() Returns the receiver's arrow color.
org.eclipse.swt.graphics.Color	getCircleBackground() Returns the receiver's circle background (when selected).
org.eclipse.swt.graphics.Color	getCircleForeground() Returns the receiver's circle foreground color.
org.eclipse.swt.graphics.Color	getCircleHoverColor() Returns the receiver's circle foreground color when mouse is over.
java.util.List<org.eclipse.swt.graphics.Image>	getImages() Returns the receiver's list of images.
int	getSelection() Returns true if the receiver is selected, and false otherwise.
void	removeImage(org.eclipse.swt.graphics.Image image) Remove the image to the collection of images
void	removeSelectionListener(org.eclipse.swt.events.SelectionListener listener) Removes the listener from the collection of listeners who will be notified when the control is selected by the user.
void	setArrowColor(org.eclipse.swt.graphics.Color arrowColor) Sets the receiver's arrow color to the color specified by the argument, or to the default system color for the control if the argument is null.
void	setBackground(org.eclipse.swt.graphics.Color color)
void	setCircleBackground(org.eclipse.swt.graphics.Color circleBackground) Sets the receiver's circle selection color to the color specified by the argument, or to the default system color for the control if the argument is null.
void	setCircleForeground(org.eclipse.swt.graphics.Color circleForeground) Sets the circle's foreground color to the color specified by the argument, or to the default system color for the control if the argument is null.
void	setCircleHoverColor(org.eclipse.swt.graphics.Color circleHoverColor) Sets the circle's foreground color (when mouse hover) to the color specified by the argument, or to the default system color for the control if the argument is null.
void	setImages(java.util.List<org.eclipse.swt.graphics.Image> images) Sets the receiver's list of images.
void	setSelection(int selected) Sets the selection state of the receiver, if it is of type CHECK or PUSH.

Methods inherited from class org.eclipse.swt.widgets.Composite

changed, checkSubclass, drawBackground, getBackgroundMode, getChildren, getLayout, getLayoutDeferred, getTabList, isLayoutDeferred, layout, layout, layout, layout, layout, setBackgroundMode, setFocus, setLayout, setLayoutDeferred, setTabList

Methods inherited from class org.eclipse.swt.widgets.Scrollable

computeTrim, getClientArea, getHorizontalBar, getScrollbarsMode, getVerticalBar

Methods inherited from class org.eclipse.swt.widgets.Control

addControlListener, addDragDetectListener, addFocusListener, addGestureListener, addHelpListener, addKeyListener, addMenuDetectListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addMouseWheelListener, addPaintListener, addTouchListener, addTraverseListener, computeSize, computeSize, dragDetect, dragDetect, forceFocus, getAccessible, getBackground, getBackgroundImage, getBorderWidth, getBounds, getCursor, getDragDetect, getEnabled, getFont, getForeground, getLayoutData, getLocation, getMenu, getMonitor, getOrientation, getParent, getRegion, getShell, getSize, getTextDirection, getToolTipText, getTouchEnabled, getVisible, internal_dispose_GC, internal_new_GC, isEnabled, isFocusControl, isReparentable, isVisible, moveAbove, moveBelow, pack, pack, print, redraw, redraw, removeControlListener, removeDragDetectListener, removeFocusListener, removeGestureListener, removeHelpListener, removeKeyListener, removeMenuDetectListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removeMouseWheelListener, removePaintListener, removeTouchListener, removeTraverseListener, requestLayout, setBackgroundImage, setBounds, setBounds, setCapture, setCursor, setDragDetect, setEnabled, setFont, setForeground, setLayoutData, setLocation, setLocation, setMenu, setOrientation, setParent, setRedraw, setRegion, setSize, setSize, setTextDirection, setToolTipText, setTouchEnabled, setVisible, toControl, toControl, toDisplay, toDisplay, traverse, traverse, traverse, update

Methods inherited from class org.eclipse.swt.widgets.Widget

addDisposeListener, checkWidget, dispose, getData, getData, getDisplay, getListeners, getStyle, isAutoDirection, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, reskin, setData, setData, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.swt.graphics.Drawable

isAutoScalable

Field Detail

selection

int selection

selectionListeners

final java.util.List<org.eclipse.swt.events.SelectionListener> selectionListeners

imageContainer

final ImageContainer imageContainer

imageSelector

final ImageSelector imageSelector

Constructor Detail

Carousel

public Carousel(org.eclipse.swt.widgets.Composite parent,
                int style)

Constructs a new instance of this class given its parent and a style value describing its behavior and appearance.

The style value is either one of the style constants defined in class SWT which is applicable to instances of this class, or must be built by bitwise OR'ing together (that is, using the int "|" operator) two or more of those SWT style constants. The class description lists the style constants that are applicable to the class. Style bits are also inherited from superclasses.

Parameters:

parent - a composite control which will be the parent of the new instance (cannot be null)

style - the style of control to construct

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the parent is null

org.eclipse.swt.SWTException -

• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent
• ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass

Method Detail

addImage

public void addImage(org.eclipse.swt.graphics.Image image)

Adds the image to the collection of images

Parameters:

image - the image to add

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if image is null

org.eclipse.swt.SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

See Also:

Image, removeImage(org.eclipse.swt.graphics.Image)

addListener

public void addListener(int eventType,
                        org.eclipse.swt.widgets.Listener listener)

Overrides:

addListener in class org.eclipse.swt.widgets.Widget

See Also:

Widget.addListener(int, org.eclipse.swt.widgets.Listener)

addSelectionListener

public void addSelectionListener(org.eclipse.swt.events.SelectionListener listener)

Adds the listener to the collection of listeners who will be notified when the control is selected by the user, by sending it one of the messages defined in the SelectionListener interface.

widgetDefaultSelected is not called.

Parameters:

listener - the listener which should be notified when the control is selected by the user,

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the listener is null

org.eclipse.swt.SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

See Also:

SelectionListener, removeSelectionListener(org.eclipse.swt.events.SelectionListener), SelectionEvent

removeImage

public void removeImage(org.eclipse.swt.graphics.Image image)

Remove the image to the collection of images

Parameters:

image - the image to remove

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if image is null

org.eclipse.swt.SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

See Also:

Image, removeImage(org.eclipse.swt.graphics.Image)

removeSelectionListener

public void removeSelectionListener(org.eclipse.swt.events.SelectionListener listener)

Removes the listener from the collection of listeners who will be notified when the control is selected by the user.

Parameters:

listener - the listener which should no longer be notified

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the listener is null

org.eclipse.swt.SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

See Also:

SelectionListener, addSelectionListener(org.eclipse.swt.events.SelectionListener)

getArrowColor

public org.eclipse.swt.graphics.Color getArrowColor()

Returns the receiver's arrow color.

Returns:

the arrow color

Throws:

org.eclipse.swt.SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

getCircleBackground

public org.eclipse.swt.graphics.Color getCircleBackground()

Returns the receiver's circle background (when selected).

Returns:

the circle background color

Throws:

org.eclipse.swt.SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

getCircleForeground

public org.eclipse.swt.graphics.Color getCircleForeground()

Returns the receiver's circle foreground color.

Returns:

the circle foreground color

Throws:

org.eclipse.swt.SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

getCircleHoverColor

public org.eclipse.swt.graphics.Color getCircleHoverColor()

Returns the receiver's circle foreground color when mouse is over.

Returns:

the circle foreground color when mouse is over

Throws:

org.eclipse.swt.SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

getImages

public java.util.List<org.eclipse.swt.graphics.Image> getImages()

Returns the receiver's list of images.

Returns:

the list of images

Throws:

org.eclipse.swt.SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

getSelection

public int getSelection()

Returns true if the receiver is selected, and false otherwise.

Note: This operation is only available if the SWT.CHECK or the SWT.PUSH flag is set.

Returns:

the selection state

Throws:

org.eclipse.swt.SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

setArrowColor

public void setArrowColor(org.eclipse.swt.graphics.Color arrowColor)

Sets the receiver's arrow color to the color specified by the argument, or to the default system color for the control if the argument is null.

Parameters:

color - the new color (or null)

Throws:

java.lang.IllegalArgumentException -

• ERROR_INVALID_ARGUMENT - if the argument has been disposed

org.eclipse.swt.SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

setBackground

public void setBackground(org.eclipse.swt.graphics.Color color)

Overrides:

setBackground in class org.eclipse.swt.widgets.Control

See Also:

Control.setBackground(org.eclipse.swt.graphics.Color)

setCircleBackground

public void setCircleBackground(org.eclipse.swt.graphics.Color circleBackground)

Sets the receiver's circle selection color to the color specified by the argument, or to the default system color for the control if the argument is null.

Parameters:

color - the new color (or null)

Throws:

java.lang.IllegalArgumentException -

• ERROR_INVALID_ARGUMENT - if the argument has been disposed

org.eclipse.swt.SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

setCircleForeground

public void setCircleForeground(org.eclipse.swt.graphics.Color circleForeground)

Sets the circle's foreground color to the color specified by the argument, or to the default system color for the control if the argument is null.

Parameters:

color - the new color (or null)

Throws:

java.lang.IllegalArgumentException -

• ERROR_INVALID_ARGUMENT - if the argument has been disposed

org.eclipse.swt.SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

setCircleHoverColor

public void setCircleHoverColor(org.eclipse.swt.graphics.Color circleHoverColor)

Sets the circle's foreground color (when mouse hover) to the color specified by the argument, or to the default system color for the control if the argument is null.

Parameters:

color - the new color (or null)

Throws:

java.lang.IllegalArgumentException -

• ERROR_INVALID_ARGUMENT - if the argument has been disposed

org.eclipse.swt.SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

setImages

public void setImages(java.util.List<org.eclipse.swt.graphics.Image> images)

Sets the receiver's list of images.

Parameters:

images - the new list of images

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the argument is null

org.eclipse.swt.SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

setSelection

public void setSelection(int selected)

Sets the selection state of the receiver, if it is of type CHECK or PUSH.

When the receiver is of type CHECK or RADIO, it is selected when it is checked. When it is of type TOGGLE, it is selected when it is pushed in.

Parameters:

selected - the new selection state

Throws:

java.lang.IllegalArgumentException -

• ERROR_INVALID_ARGUMENT - if the argument is lower than 0 or greater or equals to the number of images

org.eclipse.swt.SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver