Package org.eclipse.nebula.widgets.grid

Interface IInternalWidget

All Superinterfaces:

IRenderer

All Known Implementing Classes:

AbstractInternalWidget, DefaultCellRenderer, DefaultColumnFooterRenderer, DefaultColumnGroupHeaderRenderer, DefaultColumnHeaderRenderer, DefaultEmptyCellRenderer, GridCellRenderer, GridFooterRenderer, GridHeaderRenderer

public interface IInternalWidget
extends IRenderer

NOTE: THIS WIDGET AND ITS API ARE STILL UNDER DEVELOPMENT. THIS IS A PRE-RELEASE ALPHA VERSION. USERS SHOULD EXPECT API CHANGES IN FUTURE VERSIONS.

TODO fill in.

Author:

chris.gross@us.ibm.com

Field Summary

Fields

Modifier and Type	Field	Description
static int	LeftMouseButtonDown	Mouse down state.
static int	MouseMove	Hover State.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getHoverDetail()	Returns the hover detail object.
boolean	notify(int event, org.eclipse.swt.graphics.Point point, java.lang.Object value)	Mechanism used to notify the light weight widgets that an event occurred that it might be interested in.
void	setHoverDetail(java.lang.String detail)	Sets a string object that represents which part of the rendered image is currently under the mouse pointer.

Methods inherited from interface org.eclipse.nebula.widgets.grid.IRenderer

computeSize, paint, setBounds, setBounds, setDisplay, setExpanded, setFocus, setHover, setLocation, setLocation, setMouseDown, setSelected, setSize, setSize

Field Detail

MouseMove

static final int MouseMove

Hover State.

See Also:

Constant Field Values

LeftMouseButtonDown

static final int LeftMouseButtonDown

Mouse down state.

See Also:

Constant Field Values

Method Detail

notify

boolean notify(int event,
               org.eclipse.swt.graphics.Point point,
               java.lang.Object value)

Mechanism used to notify the light weight widgets that an event occurred that it might be interested in.

Parameters:

event - Event type.

point - Location of event.

value - New value.

Returns:

widget handled the event.

getHoverDetail

java.lang.String getHoverDetail()

Returns the hover detail object. This detail is used by the renderer to determine which part or piece of the rendered image is hovered over.

Returns:

string identifying which part of the image is being hovered over.

setHoverDetail

void setHoverDetail(java.lang.String detail)

Sets a string object that represents which part of the rendered image is currently under the mouse pointer.

Parameters:

detail - identifying string.