Package org.eclipse.nebula.widgets.gallery

Class AbstractGalleryGroupRenderer

java.lang.Object

org.eclipse.nebula.widgets.gallery.AbstractGalleryGroupRenderer

Direct Known Subclasses:

AbstractGridGroupRenderer

public abstract class AbstractGalleryGroupRenderer
extends java.lang.Object

Base class used to implement a custom gallery group renderer.

NOTE: THIS WIDGET AND ITS API ARE STILL UNDER DEVELOPMENT.

Author:

Nicolas Richeton (nicolas.richeton@gmail.com)

Constructor Summary

Constructors

Constructor	Description
AbstractGalleryGroupRenderer()

Method Summary

Modifier and Type	Method	Description
abstract void	dispose()
abstract void	draw(org.eclipse.swt.graphics.GC gc, GalleryItem group, int x, int y, int clipX, int clipY, int clipWidth, int clipHeight)	Group size informations can be retrieved from group.
Gallery	getGallery()
abstract GalleryItem	getItem(GalleryItem group, org.eclipse.swt.graphics.Point coords)	Returns the item at coords relative to the parent group.
abstract GalleryItem	getNextItem(GalleryItem item, int key)	Returns the item that should be selected when the current item is 'item' and the 'key' is pressed
int	getScrollBarIncrement()	Returns the preferred Scrollbar increment for the current gallery layout.
abstract org.eclipse.swt.graphics.Rectangle	getSize(GalleryItem item)	Returns the size of a group.
boolean	isExpanded()	Get the expand/collapse state of the current group
abstract void	layout(org.eclipse.swt.graphics.GC gc, GalleryItem group)	This method is called on each root item when the Gallery changes (resize, item addition or removal) in order to update the gallery size.
abstract boolean	mouseDown(GalleryItem group, org.eclipse.swt.events.MouseEvent e, org.eclipse.swt.graphics.Point coords)	This method can be implemented to handle mouse down events at the group level.
void	postDraw(org.eclipse.swt.graphics.GC gc)	This method is called after drawing the last item.
void	postLayout(org.eclipse.swt.graphics.GC gc)	This method is called after the layout of the last item.
void	preDraw(org.eclipse.swt.graphics.GC gc)	This method is called before drawing the first item.
void	preLayout(org.eclipse.swt.graphics.GC gc)	This method is called before the layout of the first item.
void	setExpanded(boolean selected)
void	setGallery(Gallery gallery)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractGalleryGroupRenderer

public AbstractGalleryGroupRenderer()

Method Detail

isExpanded

public boolean isExpanded()

Get the expand/collapse state of the current group

Returns:

true is the current group is expanded

setExpanded

public void setExpanded(boolean selected)

Parameters:

selected -

See Also:

isExpanded()

preDraw

public void preDraw(org.eclipse.swt.graphics.GC gc)

This method is called before drawing the first item. It can be used to calculate some values (like font metrics) that will be used for each item.

Parameters:

gc -

postDraw

public void postDraw(org.eclipse.swt.graphics.GC gc)

This method is called after drawing the last item. It may be used to cleanup and release resources created in preDraw().

Parameters:

gc -

draw

public abstract void draw(org.eclipse.swt.graphics.GC gc,
                          GalleryItem group,
                          int x,
                          int y,
                          int clipX,
                          int clipY,
                          int clipWidth,
                          int clipHeight)

Group size informations can be retrieved from group. Clipping informations

Parameters:

gc -

group -

x -

y -

dispose

public abstract void dispose()

getNextItem

public abstract GalleryItem getNextItem(GalleryItem item,
                                        int key)

Returns the item that should be selected when the current item is 'item' and the 'key' is pressed

Parameters:

item -

key -

Returns:

preLayout

public void preLayout(org.eclipse.swt.graphics.GC gc)

This method is called before the layout of the first item. It can be used to calculate some values (like font metrics) that will be used for each item.

Parameters:

gc -

postLayout

public void postLayout(org.eclipse.swt.graphics.GC gc)

This method is called after the layout of the last item.

Parameters:

gc -

layout

public abstract void layout(org.eclipse.swt.graphics.GC gc,
                            GalleryItem group)

This method is called on each root item when the Gallery changes (resize, item addition or removal) in order to update the gallery size. The implementation must update the item internal size (px) using setGroupSize(item, size); before returning.

Parameters:

gc -

group -

getItem

public abstract GalleryItem getItem(GalleryItem group,
                                    org.eclipse.swt.graphics.Point coords)

Returns the item at coords relative to the parent group.

Parameters:

group -

coords -

Returns:

getSize

public abstract org.eclipse.swt.graphics.Rectangle getSize(GalleryItem item)

Returns the size of a group.

Parameters:

item -

Returns:

mouseDown

public abstract boolean mouseDown(GalleryItem group,
                                  org.eclipse.swt.events.MouseEvent e,
                                  org.eclipse.swt.graphics.Point coords)

This method can be implemented to handle mouse down events at the group level. Usually to interact with custom group UI.

Parameters:

group - The group on which the mouse click occured

e - The original mouse event

coords - The pointer coordinates relative to the group

Returns:

false if event was handled by the group renderer and Gallery should not try to handle this event as a click on a GalleryItem.

getGallery

public Gallery getGallery()

setGallery

public void setGallery(Gallery gallery)

getScrollBarIncrement

public int getScrollBarIncrement()

Returns the preferred Scrollbar increment for the current gallery layout.

Returns: