Standard Widget Toolkit for GTK 3.125.0 · org.eclipse.swt.custom.CBanner

Field Summary

Modifier and Type	Field and Description
pack-priv static final int	BEZIER_LEFT
pack-priv static final int	BEZIER_RIGHT
pack-priv static int	BORDER1
pack-priv static final int	BORDER_BOTTOM
pack-priv static final int	BORDER_STRIPE
pack-priv static final int	BORDER_TOP
pack-priv Control	bottom
pack-priv int[]	curve
pack-priv int	curve_indent
pack-priv static final int	CURVE_TAIL
pack-priv int	curve_width
pack-priv Rectangle	curveRect
pack-priv int	curveStart
pack-priv boolean	dragging
pack-priv Control	left
pack-priv Listener	listener
pack-priv static final int	MIN_LEFT
pack-priv static final int	OFFSCREEN
pack-priv Cursor	resizeCursor
pack-priv Control	right
pack-priv int	rightDragDisplacement
pack-priv int	rightMinHeight
pack-priv int	rightMinWidth
pack-priv int	rightWidth
pack-priv boolean	simple

Inherited from org.eclipse.swt.widgets.Composite:: embeddedHandle

Constructor Summary

Access	Constructor and Description
public	CBanner(Composite a widget which will be the parent of the new instance (cannot be null) parent, int the style of widget to construct 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
pack-priv static int[]	bezier(int x0, int y0, int x1, int y1, int x2, int y2, int x3, int y3, int count)
pack-priv static int	checkStyle(int style) Hides org.eclipse.swt.widgets.Composite.checkStyle.
public Control	Returns: the control that appears on the bottom side of the banner or null getBottom() Returns the Control that appears on the bottom side of the banner.
public Rectangle	getClientArea() Overrides org.eclipse.swt.widgets.Scrollable.getClientArea. Returns a rectangle which describes the area of the receiver which is capable of displaying data (that is, not covered by the "trimmings").
public Control	Returns: the control that appears on the left side of the banner or null getLeft() Returns the Control that appears on the left side of the banner.
public Control	Returns: the control that appears on the right side of the banner or null getRight() Returns the Control that appears on the right side of the banner.
public Point	Returns: the minimum size of the control that appears on the right of the banner getRightMinimumSize() Returns the minimum size of the control that appears on the right of the banner.
public int	Returns: the width of the control that appears on the right of the banner getRightWidth() Returns the width of the control that appears on the right of the banner.
public boolean	Returns: `true` if the CBanner is rendered with a simple shape getSimple() Returns `true` if the CBanner is rendered with a simple, traditional shape.
pack-priv void	onDispose(Event event)
pack-priv void	onMouseDown(int x, int y)
pack-priv void	onMouseExit()
pack-priv void	onMouseMove(int x, int y)
pack-priv void	onMouseUp()
pack-priv void	onPaint(GC gc)
pack-priv void	onResize()
public void	setBottom(Control the control to be displayed on the bottom or null control) Set the control that appears on the bottom side of the banner.
public void	setLayout(Layout the receiver's new layout or null layout) Overrides org.eclipse.swt.widgets.Composite.setLayout. Sets the layout which is associated with the receiver to be the argument which may be null.
public void	setLeft(Control the control to be displayed on the left or null control) Set the control that appears on the left side of the banner.
public void	setRight(Control the control to be displayed on the right or null control) Set the control that appears on the right side of the banner.
public void	setRightMinimumSize(Point the minimum size of the control on the right size) Set the minimum height of the control that appears on the right side of the banner.
public void	setRightWidth(int the width of the control on the right width) Set the width of the control that appears on the right side of the banner.
public void	setSimple(boolean `true` if the CBanner should render itself in a simple, traditional style simple) Sets the shape that the CBanner will use to render itself.
pack-priv void	updateCurve(int height)

Field Detail

BEZIER_LEFT	back to summary
pack-priv static final int BEZIER_LEFT

BEZIER_RIGHT	back to summary
pack-priv static final int BEZIER_RIGHT

BORDER1	back to summary
pack-priv static int BORDER1

BORDER_BOTTOM	back to summary
pack-priv static final int BORDER_BOTTOM

BORDER_STRIPE	back to summary
pack-priv static final int BORDER_STRIPE

BORDER_TOP	back to summary
pack-priv static final int BORDER_TOP

bottom	back to summary
pack-priv Control bottom

curve	back to summary
pack-priv int[] curve

curve_indent	back to summary
pack-priv int curve_indent

CURVE_TAIL	back to summary
pack-priv static final int CURVE_TAIL

curve_width	back to summary
pack-priv int curve_width

curveRect	back to summary
pack-priv Rectangle curveRect

curveStart	back to summary
pack-priv int curveStart

dragging	back to summary
pack-priv boolean dragging

left	back to summary
pack-priv Control left

listener	back to summary
pack-priv Listener listener

MIN_LEFT	back to summary
pack-priv static final int MIN_LEFT

OFFSCREEN	back to summary
pack-priv static final int OFFSCREEN

resizeCursor	back to summary
pack-priv Cursor resizeCursor

right	back to summary
pack-priv Control right

rightDragDisplacement	back to summary
pack-priv int rightDragDisplacement

rightMinHeight	back to summary
pack-priv int rightMinHeight

rightMinWidth	back to summary
pack-priv int rightMinWidth

rightWidth	back to summary
pack-priv int rightWidth

simple	back to summary
pack-priv boolean simple

Constructor Detail

CBanner back to summary

CBanner	back to summary
public CBanner(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:Composite a widget which will be the parent of the new instance (cannot be null) style:int the style of widget to construct Exceptions IllegalArgumentException: ERROR_NULL_ARGUMENT - if the parent is null SWTException: ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent

public CBanner(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:Composite: a widget which will be the parent of the new instance (cannot be null)
style:int: the style of widget to construct

Exceptions

IllegalArgumentException:

ERROR_NULL_ARGUMENT - if the parent is null

SWTException:

ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent

Method Detail

bezier	back to summary
pack-priv static int[] bezier(int x0, int y0, int x1, int y1, int x2, int y2, int x3, int y3, int count)

checkStyle	back to summary
pack-priv static int checkStyle(int style) Hides org.eclipse.swt.widgets.Composite.checkStyle.

getBottom	back to summary
public Control getBottom() Returns the Control that appears on the bottom side of the banner. Returns:Control the control that appears on the bottom side of the banner or null Exceptions SWTException: ERROR_WIDGET_DISPOSED - if the receiver has been disposed ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver Since 3.0

getBottom

back to summary

public Control getBottom()

Returns the Control that appears on the bottom side of the banner.

Returns:Control

the control that appears on the bottom side of the banner or null

Exceptions

SWTException:

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

Since

3.0

getClientArea	back to summary
public Rectangle getClientArea() Overrides org.eclipse.swt.widgets.Scrollable.getClientArea. Doc from org.eclipse.swt.widgets.Scrollable.getClientArea. Returns a rectangle which describes the area of the receiver which is capable of displaying data (that is, not covered by the "trimmings"). Returns:Rectangle the client area Annotations @Override

getClientArea

back to summary

public Rectangle getClientArea()

Overrides org.eclipse.swt.widgets.Scrollable.getClientArea.

Doc from org.eclipse.swt.widgets.Scrollable.getClientArea.

Returns a rectangle which describes the area of the receiver which is capable of displaying data (that is, not covered by the "trimmings").

Returns:Rectangle

the client area

Annotations

@Override

getLeft	back to summary
public Control getLeft() Returns the Control that appears on the left side of the banner. Returns:Control the control that appears on the left side of the banner or null Exceptions SWTException: ERROR_WIDGET_DISPOSED - if the receiver has been disposed ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver Since 3.0

getLeft

back to summary

public Control getLeft()

Returns the Control that appears on the left side of the banner.

Returns:Control

the control that appears on the left side of the banner or null

Exceptions

SWTException:

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

Since

3.0

getRight	back to summary
public Control getRight() Returns the Control that appears on the right side of the banner. Returns:Control the control that appears on the right side of the banner or null Exceptions SWTException: ERROR_WIDGET_DISPOSED - if the receiver has been disposed ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver Since 3.0

getRight

back to summary

public Control getRight()

Returns the Control that appears on the right side of the banner.

Returns:Control

the control that appears on the right side of the banner or null

Exceptions

SWTException:

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

Since

3.0

getRightMinimumSize	back to summary
public Point getRightMinimumSize() Returns the minimum size of the control that appears on the right of the banner. Returns:Point the minimum size of the control that appears on the right of the banner Since 3.1

getRightMinimumSize

back to summary

public Point getRightMinimumSize()

Returns the minimum size of the control that appears on the right of the banner.

Returns:Point: the minimum size of the control that appears on the right of the banner
Since: 3.1

getRightWidth	back to summary
public int getRightWidth() Returns the width of the control that appears on the right of the banner. Returns:int the width of the control that appears on the right of the banner Since 3.0

getRightWidth

back to summary

public int getRightWidth()

Returns the width of the control that appears on the right of the banner.

Returns:int: the width of the control that appears on the right of the banner
Since: 3.0

getSimple back to summary

getSimple	back to summary
public boolean getSimple() Returns `true` if the CBanner is rendered with a simple, traditional shape. Returns:boolean `true` if the CBanner is rendered with a simple shape Since 3.0

public boolean getSimple()

Returns true if the CBanner is rendered with a simple, traditional shape.

Returns:boolean: true if the CBanner is rendered with a simple shape
Since: 3.0

onDispose	back to summary
pack-priv void onDispose(Event event)

onMouseDown	back to summary
pack-priv void onMouseDown(int x, int y)

onMouseExit	back to summary
pack-priv void onMouseExit()

onMouseMove	back to summary
pack-priv void onMouseMove(int x, int y)

onMouseUp	back to summary
pack-priv void onMouseUp()

onPaint	back to summary
pack-priv void onPaint(GC gc)

onResize	back to summary
pack-priv void onResize()

setBottom	back to summary
public void setBottom(Control control) Set the control that appears on the bottom side of the banner. The bottom control is optional. Setting the bottom control to null will remove it from the banner - however, the creator of the control must dispose of the control. Parameters control:Control the control to be displayed on the bottom or null Exceptions SWTException: ERROR_WIDGET_DISPOSED - if the receiver has been disposed ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver ERROR_INVALID_ARGUMENT - if the bottom control was not created as a child of the receiver Since 3.0

setBottom

back to summary

public void setBottom(Control control)

Set the control that appears on the bottom side of the banner. The bottom control is optional. Setting the bottom control to null will remove it from the banner - however, the creator of the control must dispose of the control.

Parameters

control:Control: the control to be displayed on the bottom or null

Exceptions

SWTException:

ERROR_WIDGET_DISPOSED - if the receiver has been disposed
ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
ERROR_INVALID_ARGUMENT - if the bottom control was not created as a child of the receiver

Since

3.0

setLayout	back to summary
public void setLayout(Layout layout) Overrides org.eclipse.swt.widgets.Composite.setLayout. Sets the layout which is associated with the receiver to be the argument which may be null. Note No Layout can be set on this Control because it already manages the size and position of its children. Parameters layout:Layout the receiver's new layout or null Annotations @Override Exceptions SWTException: ERROR_WIDGET_DISPOSED - if the receiver has been disposed ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

setLayout

back to summary

public void setLayout(Layout layout)

Overrides org.eclipse.swt.widgets.Composite.setLayout.

Sets the layout which is associated with the receiver to be the argument which may be null.

Note

No Layout can be set on this Control because it already manages the size and position of its children.

Parameters

layout:Layout: the receiver's new layout or null

Annotations

@Override

Exceptions

SWTException:

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

setLeft	back to summary
public void setLeft(Control control) Set the control that appears on the left side of the banner. The left control is optional. Setting the left control to null will remove it from the banner - however, the creator of the control must dispose of the control. Parameters control:Control the control to be displayed on the left or null Exceptions SWTException: ERROR_WIDGET_DISPOSED - if the receiver has been disposed ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver ERROR_INVALID_ARGUMENT - if the left control was not created as a child of the receiver Since 3.0

setLeft

back to summary

public void setLeft(Control control)

Set the control that appears on the left side of the banner. The left control is optional. Setting the left control to null will remove it from the banner - however, the creator of the control must dispose of the control.

Parameters

control:Control: the control to be displayed on the left or null

Exceptions

SWTException:

ERROR_WIDGET_DISPOSED - if the receiver has been disposed
ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
ERROR_INVALID_ARGUMENT - if the left control was not created as a child of the receiver

Since

3.0

setRight	back to summary
public void setRight(Control control) Set the control that appears on the right side of the banner. The right control is optional. Setting the right control to null will remove it from the banner - however, the creator of the control must dispose of the control. Parameters control:Control the control to be displayed on the right or null Exceptions SWTException: ERROR_WIDGET_DISPOSED - if the receiver has been disposed ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver ERROR_INVALID_ARGUMENT - if the right control was not created as a child of the receiver Since 3.0

setRight

back to summary

public void setRight(Control control)

Set the control that appears on the right side of the banner. The right control is optional. Setting the right control to null will remove it from the banner - however, the creator of the control must dispose of the control.

Parameters

control:Control: the control to be displayed on the right or null

Exceptions

SWTException:

ERROR_WIDGET_DISPOSED - if the receiver has been disposed
ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
ERROR_INVALID_ARGUMENT - if the right control was not created as a child of the receiver

Since

3.0

setRightMinimumSize	back to summary
public void setRightMinimumSize(Point size) Set the minimum height of the control that appears on the right side of the banner. Parameters size:Point the minimum size of the control on the right Exceptions SWTException: ERROR_WIDGET_DISPOSED - if the receiver has been disposed ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver ERROR_INVALID_ARGUMENT - if the size is null or the values of size are less than SWT.DEFAULT Since 3.1

setRightMinimumSize

back to summary

public void setRightMinimumSize(Point size)

Set the minimum height of the control that appears on the right side of the banner.

Parameters

size:Point: the minimum size of the control on the right

Exceptions

SWTException:

ERROR_WIDGET_DISPOSED - if the receiver has been disposed
ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
ERROR_INVALID_ARGUMENT - if the size is null or the values of size are less than SWT.DEFAULT

Since

3.1

setRightWidth

back to summary

public void setRightWidth(int width)

Set the width of the control that appears on the right side of the banner.

Parameters

width:int: the width of the control on the right

Exceptions

SWTException:

ERROR_WIDGET_DISPOSED - if the receiver has been disposed
ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
ERROR_INVALID_ARGUMENT - if width is less than SWT.DEFAULT

Since

3.0

setSimple back to summary

public void setSimple(boolean simple)

Sets the shape that the CBanner will use to render itself.

Parameters

simple:boolean: true if the CBanner should render itself in a simple, traditional style

Exceptions

SWTException:

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

Since

3.0

updateCurve	back to summary
pack-priv void updateCurve(int height)

public Class CBanner

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail