public class Section extends ExpandableComposite
In case of the TITLE_BAR style, Section renders the title bar in a way compatible with the rest of the workbench. Since it is a widget, all the colors must be supplied directly. When created by the form toolkit, these colors are supplied by the toolkit. The toolkit initializes these colors based on the system colors. For this reason, it is recommended to create the section by the toolkit instead of through its own constructor.
Since 3.1, it is possible to set a control to be used for section
description. If used, DESCRIPTION style should not be set. A
typical way to take advantage of the new method is to set an instance of
FormText to provide for hyperlinks and images in the
description area.
| Modifier and Type | Field and Description |
|---|---|
static int |
DESCRIPTION
Description style.
|
CLIENT_INDENT, clientVerticalSpacing, COMPACT, EXPANDED, FOCUS_TITLE, GAP, LEFT_TEXT_CLIENT_ALIGNMENT, marginHeight, marginWidth, NO_TITLE, SHORT_TITLE_BAR, textLabel, TITLE_BAR, toggle, TREE_NODE, TWISTIE| Constructor and Description |
|---|
Section(Composite parent,
int style)
Creates a new section instance in the provided parent.
|
| Modifier and Type | Method and Description |
|---|---|
String |
getDescription()
Returns the current description text.
|
Control |
getDescriptionControl()
Returns the control used to render the description.
|
Control |
getSeparatorControl()
Returns the control that is used as a separator betweeen the title and
the client, or null if not set.
|
Color |
getTitleBarBackground()
Returns the title bar background when TITLE_BAR style is used.
|
Color |
getTitleBarBorderColor()
Returns the title bar border color when TITLE_BAR style is used.
|
Color |
getTitleBarGradientBackground()
Returns the title bar gradient background color when TITLE_BAR style is
used.
|
protected void |
internalSetExpanded(boolean expanded)
Performs the expansion state change for the expandable control.
|
protected void |
onPaint(PaintEvent e)
If TITLE_BAR or SHORT_TITLE_BAR style is used, title bar decoration will
be painted behind the text in this method.
|
protected void |
reflow()
Reflows this section and all the parents up the hierarchy
until a ScrolledForm is reached.
|
void |
setBackground(Color bg)
Sets the background of the section.
|
void |
setBackgroundImage(Image image)
Background image is used for the title gradient - does nothing.
|
void |
setDescription(String description)
Sets the description text.
|
void |
setDescriptionControl(Control descriptionControl)
Sets the description control of this section.
|
void |
setForeground(Color fg)
Sets the foreground of the section.
|
void |
setSeparatorControl(Control separator)
Sets the separator control of this section.
|
void |
setTitleBarBackground(Color color)
Sets the color of the title bar background when TITLE_BAR style is used.
|
void |
setTitleBarBorderColor(Color color)
Sets the color of the title bar border when TITLE_BAR style is used.
|
void |
setTitleBarGradientBackground(Color color)
Sets the color of the title bar gradient background when TITLE_BAR style
is used.
|
addExpansionListener, computeSize, getClient, getExpansionStyle, getText, getTextClient, getTitleBarForeground, hasTitleBar, isExpanded, isFixedStyle, removeExpansionListener, setActiveToggleColor, setClient, setExpanded, setFont, setLayout, setMenu, setText, setTextClient, setTitleBarForeground, setToggleColordrawBackground, getCaret, scroll, setCaretchanged, checkSubclass, getBackgroundMode, getChildren, getLayout, getLayoutDeferred, getTabList, isLayoutDeferred, layout, layout, layout, layout, setBackgroundMode, setFocus, setLayoutDeferred, setTabListcomputeTrim, getClientArea, getHorizontalBar, getVerticalBaraddControlListener, addFocusListener, addHelpListener, addKeyListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addPaintListener, addTraverseListener, computeSize, forceFocus, getAccessible, getBackground, getBackgroundImage, getBorderWidth, getBounds, getEnabled, getFont, getForeground, getLayoutData, getLocation, getMenu, getMonitor, getParent, getShell, getSize, getToolTipText, getVisible, internal_dispose_GC, internal_new_GC, isEnabled, isFocusControl, isReparentable, isVisible, moveAbove, moveBelow, pack, pack, redraw, redraw, removeControlListener, removeFocusListener, removeHelpListener, removeKeyListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removePaintListener, removeTraverseListener, setBounds, setBounds, setCapture, setCursor, setEnabled, setLayoutData, setLocation, setLocation, setParent, setRedraw, setSize, setSize, setToolTipText, setVisible, toControl, toControl, toDisplay, toDisplay, traverse, updateaddDisposeListener, addListener, checkWidget, dispose, getData, getData, getDisplay, getStyle, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, setData, setData, toStringpublic static final int DESCRIPTION
public Section(Composite parent, int style)
parent - the parent compositestyle - the style to useprotected void internalSetExpanded(boolean expanded)
ExpandableCompositeinternalSetExpanded in class ExpandableCompositeexpanded - the expansion stateprotected void reflow()
public void setDescription(String description)
description - public String getDescription()
null if DESCRIPTION style was
not used to create the control.public void setSeparatorControl(Control separator)
separator - the separator that will be placed below the title text.public Control getSeparatorControl()
getSeparatorControl in class ExpandableCompositepublic void setBackground(Color bg)
setBackground in class ExpandableCompositebg - the new backgroundpublic void setForeground(Color fg)
setForeground in class ExpandableCompositefg - the new foreground.public Control getDescriptionControl()
getDescriptionControl in class ExpandableCompositenull if DESCRIPTION style
was not used to create the control and description control was
not set by the client.setDescriptionControl(org.eclipse.swt.widgets.Control)public void setDescriptionControl(Control descriptionControl)
This method and DESCRIPTION style are mutually exclusive.
Use the method only if you want to create the description control
yourself.
descriptionControl - the control that will be placed below the title text.public void setTitleBarBorderColor(Color color)
color - the title bar border colorpublic void setTitleBarBackground(Color color)
color - the title bar border backgroundpublic void setTitleBarGradientBackground(Color color)
color - the title bar gradient backgroundpublic Color getTitleBarBorderColor()
public Color getTitleBarGradientBackground()
public Color getTitleBarBackground()
protected void onPaint(PaintEvent e)
ExpandableCompositeonPaint in class ExpandableCompositee - the paint eventpublic final void setBackgroundImage(Image image)
setBackgroundImage in class Controlimage - the new image (or null)Guidelines for using Eclipse APIs. Copyright (c) IBM Corp. and others 2000, 2006. All rights reserved.