|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.swt.widgets.Widget
org.eclipse.swt.widgets.Control
org.eclipse.swt.widgets.Scrollable
org.eclipse.swt.widgets.Composite
org.eclipse.ui.forms.widgets.ExpandableComposite
org.eclipse.ui.forms.widgets.Section
A variation of the expandable composite that adds optional description below the title. Section is often used as a basic building block if forms because it provides for logical grouping of information.
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.
Field Summary | |
---|---|
static int |
DESCRIPTION
Description style. |
Fields inherited from class org.eclipse.ui.forms.widgets.ExpandableComposite |
---|
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 |
Fields inherited from class org.eclipse.swt.widgets.Control |
---|
handle |
Constructor Summary | |
---|---|
Section(Composite parent,
int style)
Creates a new section instance in the provided parent. |
Method Summary | |
---|---|
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 |
getTitleBarForeground()
Returns the title bar foreground 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()
|
void |
setBackground(Color bg)
Sets the background of the section. |
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 |
setTitleBarForeground(Color color)
Sets the color of the title bar foreground 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. |
Methods inherited from class org.eclipse.ui.forms.widgets.ExpandableComposite |
---|
addExpansionListener, computeSize, getClient, getExpansionStyle, getText, getTextClient, hasTitleBar, isExpanded, isFixedStyle, removeExpansionListener, setActiveToggleColor, setClient, setExpanded, setFont, setLayout, setMenu, setText, setTextClient, setToggleColor |
Methods inherited from class org.eclipse.swt.widgets.Composite |
---|
changed, checkSubclass, getChildren, getLayout, getLayoutDeferred, getTabList, isLayoutDeferred, layout, layout, layout, layout, setFocus, 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, getStyle, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, setData, setData, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final int DESCRIPTION
Constructor Detail |
public Section(Composite parent, int style)
parent
- the parent compositestyle
- the style to useMethod Detail |
protected void internalSetExpanded(boolean expanded)
ExpandableComposite
internalSetExpanded
in class ExpandableComposite
expanded
- 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 ExpandableComposite
public void setBackground(Color bg)
setBackground
in class ExpandableComposite
bg
- the new backgroundpublic void setForeground(Color fg)
setForeground
in class ExpandableComposite
fg
- the new foreground.public Control getDescriptionControl()
getDescriptionControl
in class ExpandableComposite
null
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 setTitleBarForeground(Color color)
color
- the title bar foregroundpublic 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 getTitleBarForeground()
public Color getTitleBarBackground()
protected void onPaint(PaintEvent e)
ExpandableComposite
onPaint
in class ExpandableComposite
e
- the paint event
|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.