|
Eclipse Remote Application Platform | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.swt.widgets.CoolBar
public class CoolBar
Instances of this class provide an area for dynamically positioning the items they contain.
The item children that may be added to instances of this class must be of
type CoolItem
.
Note that although this class is a subclass of Composite
, it
does not make sense to add Control
children to it, or set a
layout on it.
Note: Only one of the styles HORIZONTAL and VERTICAL may be specified.
IMPORTANT: This class is not intended to be subclassed.
Constructor Summary | |
---|---|
CoolBar(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 | ||
---|---|---|
protected void |
checkSubclass()
Checks that this class can be subclassed. |
|
Point |
computeSize(int wHint,
int hHint,
boolean changed)
Returns the preferred size of the receiver. |
|
|
getAdapter(java.lang.Class<T> adapter)
Implementation of the Adaptable interface. |
|
CoolItem |
getItem(int index)
Returns the item that is currently displayed at the given, zero-relative index. |
|
int |
getItemCount()
Returns the number of items contained in the receiver. |
|
int[] |
getItemOrder()
Returns an array of zero-relative ints that map the creation order of the receiver's items to the order in which they are currently being displayed. |
|
CoolItem[] |
getItems()
Returns an array of CoolItem s in the order in which they
are currently being displayed. |
|
Point[] |
getItemSizes()
Returns an array of points whose x and y coordinates describe the widths and heights (respectively) of the items in the receiver in the order in which they are currently being displayed. |
|
boolean |
getLocked()
Returns whether or not the receiver is 'locked'. |
|
int[] |
getWrapIndices()
Returns an array of ints that describe the zero-relative indices of any item(s) in the receiver that will begin on a new row. |
|
int |
indexOf(CoolItem item)
Searches the receiver's items in the order they are currently being displayed, starting at the first item (index 0), until an item is found that is equal to the argument, and returns the index of that item. |
|
void |
setItemLayout(int[] itemOrder,
int[] wrapIndices,
Point[] sizes)
Sets the receiver's item order, wrap indices, and item sizes all at once. |
|
void |
setLocked(boolean locked)
Sets whether or not the receiver is 'locked'. |
|
void |
setWrapIndices(int[] indices)
Sets the indices of all item(s) in the receiver that will begin on a new row. |
Methods inherited from class org.eclipse.swt.widgets.Composite |
---|
changed, 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, getVerticalBar |
Methods inherited from class org.eclipse.swt.widgets.Widget |
---|
addDisposeListener, addListener, checkWidget, dispose, getData, getData, getDisplay, getListeners, getStyle, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, reskin, setData, setData, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public CoolBar(Composite parent, int style)
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.
parent
- a composite control which will be the parent of the new instance
(cannot be null)style
- the style of control to construct
java.lang.IllegalArgumentException
- SWTException
- SWT
,
Widget.checkSubclass()
,
Widget.getStyle()
Method Detail |
---|
protected void checkSubclass()
Widget
The SWT class library is intended to be subclassed
only at specific, controlled points (most notably,
Composite
and Canvas
when
implementing new widgets). This method enforces this
rule unless it is overridden.
IMPORTANT: By providing an implementation of this method that allows a subclass of a class which does not normally allow subclassing to be created, the implementer agrees to be fully responsible for the fact that any such subclass will likely fail between SWT releases and will be strongly platform specific. No support is provided for user-written classes which are implemented in this fashion.
The ability to subclass outside of the allowed SWT classes is intended purely to enable those not on the SWT development team to implement patches in order to get around specific limitations in advance of when those limitations can be addressed by the team. Subclassing should not be attempted without an intimate and detailed understanding of the hierarchy.
checkSubclass
in class Widget
public Point computeSize(int wHint, int hHint, boolean changed)
Control
The preferred size of a control is the size that it would
best be displayed at. The width hint and height hint arguments
allow the caller to ask a control questions such as "Given a particular
width, how high does the control need to be to show all of the contents?"
To indicate that the caller does not wish to constrain a particular
dimension, the constant SWT.DEFAULT
is passed for the hint.
If the changed flag is true
, it indicates that the receiver's
contents have changed, therefore any caches that a layout manager
containing the control may have been keeping need to be flushed. When the
control is resized, the changed flag will be false
, so layout
manager caches can be retained.
computeSize
in class Composite
wHint
- the width hint (can be SWT.DEFAULT
)hHint
- the height hint (can be SWT.DEFAULT
)changed
- true
if the control's contents have changed, and false
otherwise
Layout
,
Control.getBorderWidth()
,
Control.getBounds()
,
Control.getSize()
,
Control.pack(boolean)
,
"computeTrim, getClientArea for controls that implement them"public CoolItem getItem(int index)
index
- the visual index of the item to return
java.lang.IllegalArgumentException
- SWTException
- public int getItemCount()
SWTException
- public CoolItem[] getItems()
CoolItem
s in the order in which they
are currently being displayed.
Note: This is not the actual structure used by the receiver to maintain its list of items, so modifying the array will not affect the receiver.
SWTException
- public int indexOf(CoolItem item)
item
- the search item
java.lang.IllegalArgumentException
- SWTException
- public int[] getItemOrder()
Specifically, the indices of the returned array represent the current visual order of the items, and the contents of the array represent the creation order of the items.
Note: This is not the actual structure used by the receiver to maintain its list of items, so modifying the array will not affect the receiver.
SWTException
- public Point[] getItemSizes()
SWTException
- public boolean getLocked()
SWTException
- public int[] getWrapIndices()
SWTException
- public void setLocked(boolean locked)
locked
- lock the coolbar if true, otherwise unlock the coolbar
SWTException
- public void setWrapIndices(int[] indices)
indices
- an array of wrap indices, or null
SWTException
- public void setItemLayout(int[] itemOrder, int[] wrapIndices, Point[] sizes)
The item order is the order in which the items in the receiver should be displayed, given in terms of the zero-relative ordering of when the items were added.
The wrap indices are the indices of all item(s) in the receiver that will begin on a new row. The indices are given in the order specified by the item order. The 0th item always begins the first row, therefore it does not count as a wrap index. If wrap indices is null or empty, the items will be placed on one line.
The sizes are specified in an array of points whose x and y coordinates describe the new widths and heights (respectively) of the receiver's items in the order specified by the item order.
itemOrder
- an array of indices that describe the new order to display the
items inwrapIndices
- an array of wrap indices, or nullsizes
- an array containing the new sizes for each of the receiver's items
in visual order
SWTException
- java.lang.IllegalArgumentException
- public <T> T getAdapter(java.lang.Class<T> adapter)
Widget
Adaptable
interface.
IMPORTANT: This method is not part of the RWT public API. It is marked public only so that it can be shared within the packages provided by RWT. It should never be accessed from application code.
getAdapter
in interface Adaptable
getAdapter
in class Composite
adapter
- the lookup class
null
if
there is no adapter associated with the given class.
|
Eclipse Remote Application Platform | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright (c) EclipseSource and others 2002, 2013. All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0