| org.eclipse.ui.forms.widgets.SharedScrolledComposite
 org.eclipse.ui.forms.widgets.ScrolledPageBook
| ScrolledPageBook | | public class ScrolledPageBook extends SharedScrolledComposite (Code) | | ScrolledPageBook is a class that is capable of stacking several composites
(pages), while showing one at a time. The content is scrolled if there is
not enough space to fit it in the client area.
since:
3.0 |
| Constructor Summary | |
| public | ScrolledPageBook(Composite parent)
| | public | ScrolledPageBook(Composite parent, int style)
Creates a new instance in the provided parent and with the provided
style. |
| Method Summary | |
| public Point | computeSize(int wHint, int hHint, boolean changed)
Removes the default size of the composite, allowing the control to
shrink to the trim. | | public Composite | createPage(Object key)
Creates a new page for the provided key. | | public Composite | getContainer()
Returns the page book container. | | public Control | getCurrentPage()
Returns the page currently showing. | | public boolean | hasPage(Object key)
Tests if the page under the provided key is currently in the book. | | public void | registerPage(Object key, Control page)
Registers a page under the privided key to be managed by the page book. | | public void | removePage(Object key)
Removes the page under the provided key from the page book. | | public void | removePage(Object key, boolean showEmptyPage)
Removes the page under the provided key from the page book. | | public boolean | setFocus()
Sets focus on the current page if shown. | | public void | showEmptyPage()
Shows a page with no children to be used if the desire is to not show
any registered page. | | public void | showPage(Object key)
Shows the page with the provided key and hides the page previously
showing. |
| ScrolledPageBook | | public ScrolledPageBook(Composite parent)(Code) | | Creates a new instance in the provided parent
Parameters:
parent - |
| ScrolledPageBook | | public ScrolledPageBook(Composite parent, int style)(Code) | | Creates a new instance in the provided parent and with the provided
style.
Parameters:
parent - the control parent
Parameters:
style - the style to use |
| computeSize | | public Point computeSize(int wHint, int hHint, boolean changed)(Code) | | Removes the default size of the composite, allowing the control to
shrink to the trim.
Parameters:
wHint - the width hint
Parameters:
hHint - the height hint
Parameters:
changed - if true, do not use cached values |
| createPage | | public Composite createPage(Object key)(Code) | | Creates a new page for the provided key. Use the returned composite to
create children in it.
Parameters:
key - the page key the newly created page composite |
| getContainer | | public Composite getContainer()(Code) | | Returns the page book container.
the page book container |
| getCurrentPage | | public Control getCurrentPage()(Code) | | Returns the page currently showing.
the current page |
| hasPage | | public boolean hasPage(Object key)(Code) | | Tests if the page under the provided key is currently in the book.
Parameters:
key - the page key true if page exists, falseotherwise. |
| removePage | | public void removePage(Object key)(Code) | | Removes the page under the provided key from the page book. Does nothing
if page with that key does not exist.
Parameters:
key - the page key. |
| removePage | | public void removePage(Object key, boolean showEmptyPage)(Code) | | Removes the page under the provided key from the page book. Does nothing
if page with that key does not exist.
Parameters:
key - the page key.
Parameters:
showEmptyPage - if true, shows the empty pageafter page removal. |
| setFocus | | public boolean setFocus()(Code) | | Sets focus on the current page if shown.
|
| showEmptyPage | | public void showEmptyPage()(Code) | | Shows a page with no children to be used if the desire is to not show
any registered page.
|
| showPage | | public void showPage(Object key)(Code) | | Shows the page with the provided key and hides the page previously
showing. Does nothing if the page with that key does not exist.
Parameters:
key - the page key |
|
|