|
| |
|
| org.eclipse.ui.forms.widgets.ExpandableComposite
 org.eclipse.ui.forms.widgets.Section
| Section | | public class Section extends ExpandableComposite (Code) | | A variation of the expandable composite that adds optional description below
the title. Section is often used as a basic building block in 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.
since:
3.0 |
| Field Summary | |
| final public static int | DESCRIPTION
Description style. |
| Constructor Summary | |
| public | Section(Composite parent, int style)
Creates a new section instance in the provided parent. | | | Section(Composite parent, int cstyle, int style)
|
| Method Summary | |
| public String | getDescription()
Returns the current description text. | | public Control | getDescriptionControl()
Returns the control used to render the description. | | public Control | getSeparatorControl()
Returns the control that is used as a separator betweeen the title and
the client, or null if not set. | | public Color | getTitleBarBackground()
Returns the title bar background when TITLE_BAR style is used. | | public Color | getTitleBarBorderColor()
Returns the title bar border color when TITLE_BAR style is used. | | public Color | getTitleBarGradientBackground()
Returns the title bar gradient background color when TITLE_BAR style is
used. | | protected void | internalSetExpanded(boolean expanded)
| | protected void | onPaint(PaintEvent e)
| | protected void | reflow()
Reflows this section and all the parents up the hierarchy until a
ScrolledForm is reached. | | public void | setBackground(Color bg)
Sets the background of the section. | | final public void | setBackgroundImage(Image image)
Background image is used for the title gradient - does nothing. | | public void | setDescription(String description)
Sets the description text. | | public void | setDescriptionControl(Control descriptionControl)
Sets the description control of this section. | | public void | setForeground(Color fg)
Sets the foreground of the section. | | public void | setSeparatorControl(Control separator)
Sets the separator control of this section. | | public void | setTitleBarBackground(Color color)
Sets the color of the title bar background when TITLE_BAR style is used. | | public void | setTitleBarBorderColor(Color color)
Sets the color of the title bar border when TITLE_BAR style is used. | | public void | setTitleBarGradientBackground(Color color)
Sets the color of the title bar gradient background when TITLE_BAR style
is used. |
| DESCRIPTION | | final public static int DESCRIPTION(Code) | | Description style. If used, description will be rendered below the title.
|
| Section | | public Section(Composite parent, int style)(Code) | | Creates a new section instance in the provided parent.
Parameters:
parent - the parent composite
Parameters:
style - the style to use |
| Section | | Section(Composite parent, int cstyle, int style)(Code) | | |
| getDescription | | public String getDescription()(Code) | | Returns the current description text.
description text or null if DESCRIPTION style wasnot used to create the control. |
| getDescriptionControl | | public Control getDescriptionControl()(Code) | | Returns the control used to render the description. In 3.1, this method
was promoted to public.
description control or null if DESCRIPTION stylewas not used to create the control and description control wasnot set by the client.
See Also: Section.setDescriptionControl(org.eclipse.swt.widgets.Control) |
| getSeparatorControl | | public Control getSeparatorControl()(Code) | | Returns the control that is used as a separator betweeen the title and
the client, or null if not set.
separator control or null if not set. |
| getTitleBarBackground | | public Color getTitleBarBackground()(Code) | | Returns the title bar background when TITLE_BAR style is used.
the title bar background |
| getTitleBarBorderColor | | public Color getTitleBarBorderColor()(Code) | | Returns the title bar border color when TITLE_BAR style is used.
the title bar border color |
| getTitleBarGradientBackground | | public Color getTitleBarGradientBackground()(Code) | | Returns the title bar gradient background color when TITLE_BAR style is
used.
the title bar gradient background |
| internalSetExpanded | | protected void internalSetExpanded(boolean expanded)(Code) | | |
| onPaint | | protected void onPaint(PaintEvent e)(Code) | | |
| reflow | | protected void reflow()(Code) | | Reflows this section and all the parents up the hierarchy until a
ScrolledForm is reached.
|
| setBackground | | public void setBackground(Color bg)(Code) | | Sets the background of the section.
Parameters:
bg - the new background |
| setBackgroundImage | | final public void setBackgroundImage(Image image)(Code) | | Background image is used for the title gradient - does nothing.
|
| setDescription | | public void setDescription(String description)(Code) | | Sets the description text. Has no effect if DESCRIPTION style was not
used to create the control.
Parameters:
description - |
| setDescriptionControl | | public void setDescriptionControl(Control descriptionControl)(Code) | | Sets the description control of this section. The control must not be
null and must be a direct child of this container. If
defined, contol will be placed below the title text and the separator and
will be hidden int he collapsed state.
This method and DESCRIPTION style are mutually exclusive.
Use the method only if you want to create the description control
yourself.
since:
3.1
Parameters:
descriptionControl - the control that will be placed below the title text. |
| setForeground | | public void setForeground(Color fg)(Code) | | Sets the foreground of the section.
Parameters:
fg - the new foreground. |
| setSeparatorControl | | public void setSeparatorControl(Control separator)(Code) | | Sets the separator control of this section. The separator must not be
null and must be a direct child of this container. If
defined, separator will be placed below the title text and will remain
visible regardless of the expansion state.
Parameters:
separator - the separator that will be placed below the title text. |
| setTitleBarBackground | | public void setTitleBarBackground(Color color)(Code) | | Sets the color of the title bar background when TITLE_BAR style is used.
This color is used as a starting color for the vertical gradient.
Parameters:
color - the title bar border background |
| setTitleBarBorderColor | | public void setTitleBarBorderColor(Color color)(Code) | | Sets the color of the title bar border when TITLE_BAR style is used.
Parameters:
color - the title bar border color |
| setTitleBarGradientBackground | | public void setTitleBarGradientBackground(Color color)(Code) | | Sets the color of the title bar gradient background when TITLE_BAR style
is used. This color is used at the height where title controls end
(toggle, tool bar).
Parameters:
color - the title bar gradient background |
|
|
|