|
Eclipse Platform Release 3.7 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.eclipse.ui.part.Page
org.eclipse.ui.views.properties.tabbed.TabbedPropertySheetPage
public class TabbedPropertySheetPage
A property sheet page that provides a tabbed UI.
| Field Summary | |
|---|---|
protected IStructuredContentProvider |
tabListContentProvider
|
| Constructor Summary | |
|---|---|
TabbedPropertySheetPage(ITabbedPropertySheetPageContributor tabbedPropertySheetPageContributor)
create a new tabbed property sheet page. |
|
TabbedPropertySheetPage(ITabbedPropertySheetPageContributor tabbedPropertySheetPageContributor,
boolean showTitleBar)
create a new tabbed property sheet page. |
|
| Method Summary | |
|---|---|
void |
addTabSelectionListener(ITabSelectionListener listener)
Add a tab selection listener. |
void |
createControl(Composite parent)
Creates the SWT control for this page under the given parent control. |
protected TabContents |
createTab(ITabDescriptor tabDescriptor)
Create the tab contents for the provided tab descriptor. |
void |
dispose()
The Page implementation of this IPage method
disposes of this page's control (if it has one and it has not already
been disposed). |
ITabDescriptor[] |
getActiveTabs()
Returns the list of currently active tabs. |
Control |
getControl()
The Page implementation of this IPage method returns
null. |
TabContents |
getCurrentTab()
Get the currently active tab. |
ITabDescriptor |
getSelectedTab()
Returns the currently selected tab. |
protected IStructuredContentProvider |
getTabListContentProvider()
Gets the tab list content provider for the contributor. |
Image |
getTitleImage(ISelection selection)
Returns the title image for given selection. |
String |
getTitleText(ISelection selection)
Returns text of the properties title for given selection. |
TabbedPropertySheetWidgetFactory |
getWidgetFactory()
Get the widget factory. |
protected void |
handlePartActivated(IWorkbenchPart part)
Handle the part activated event. |
void |
labelProviderChanged(LabelProviderChangedEvent event)
Notifies this listener that the state of the label provider has changed in a way that affects the labels it computes. |
void |
overrideTabs()
Override the tabs with a new set of tabs. |
void |
refresh()
Refresh the currently active tab. |
void |
removeTabSelectionListener(ITabSelectionListener listener)
Remove a tab selection listener. |
void |
resizeScrolledComposite()
Resize the scrolled composite enclosing the sections, which may result in the addition or removal of scroll bars. |
void |
selectionChanged(IWorkbenchPart part,
ISelection selection)
Notifies this listener that the selection has changed. |
void |
setActionBars(IActionBars actionBars)
Allows the page to make contributions to the given action bars. |
void |
setFocus()
The Page implementation of this IPage method
does nothing. |
void |
setSelectedTab(String id)
Set the currently selected tab to be that of the provided tab id. |
protected void |
updateTabs(ITabDescriptor[] descriptors)
Update the current tabs to represent the given input object. |
| Methods inherited from class org.eclipse.ui.part.Page |
|---|
getSite, init, makeContributions |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
protected IStructuredContentProvider tabListContentProvider
| Constructor Detail |
|---|
public TabbedPropertySheetPage(ITabbedPropertySheetPageContributor tabbedPropertySheetPageContributor)
tabbedPropertySheetPageContributor - the tabbed property sheet page contributor.
public TabbedPropertySheetPage(ITabbedPropertySheetPageContributor tabbedPropertySheetPageContributor,
boolean showTitleBar)
tabbedPropertySheetPageContributor - the tabbed property sheet page contributor.showTitleBar - boolean indicating if the title bar should be shown;
default value is true| Method Detail |
|---|
protected void handlePartActivated(IWorkbenchPart part)
part - the new activated part.public void createControl(Composite parent)
IPageClients should not call this method (the workbench calls this method when it needs to, which may be never).
createControl in interface IPagecreateControl in class Pageparent - the parent controlIPage.createControl(org.eclipse.swt.widgets.Composite)protected IStructuredContentProvider getTabListContentProvider()
public void dispose()
PagePage implementation of this IPage method
disposes of this page's control (if it has one and it has not already
been disposed). Subclasses may extend.
dispose in interface IPagedispose in class PageIPage.dispose()public Control getControl()
PagePage implementation of this IPage method returns
null. Subclasses must reimplement.
getControl in interface IPagegetControl in class Pagenull if this
page does not have a controlIPage.getControl()public void setActionBars(IActionBars actionBars)
IPage
This method is automatically called shortly after
createControl is called
setActionBars in interface IPagesetActionBars in class PageactionBars - the action bars for this pageIPage.setActionBars(org.eclipse.ui.IActionBars)public void setFocus()
PagePage implementation of this IPage method
does nothing. Subclasses must implement.
setFocus in interface IPagesetFocus in class PageIPage.setFocus()
public void selectionChanged(IWorkbenchPart part,
ISelection selection)
ISelectionListener
This method is called when the selection changes from one to a
non-null value, but not when the selection changes to
null. If there is a requirement to be notified in the latter
scenario, implement INullSelectionListener. The event will
be posted through this method.
selectionChanged in interface ISelectionListenerpart - the workbench part containing the selectionselection - the current selection. This may be null
if INullSelectionListener is implemented.ISelectionListener.selectionChanged(org.eclipse.ui.IWorkbenchPart,
org.eclipse.jface.viewers.ISelection)public void resizeScrolledComposite()
protected void updateTabs(ITabDescriptor[] descriptors)
protected TabContents createTab(ITabDescriptor tabDescriptor)
tabDescriptor - the tab descriptor.
public void refresh()
public TabContents getCurrentTab()
public void addTabSelectionListener(ITabSelectionListener listener)
listener - a tab selection listener.public void removeTabSelectionListener(ITabSelectionListener listener)
listener - a tab selection listener.public void overrideTabs()
AbstractOverridableTabListPropertySection by the
IOverridableTabListContentProvider.
public TabbedPropertySheetWidgetFactory getWidgetFactory()
public void labelProviderChanged(LabelProviderChangedEvent event)
ILabelProviderListenerA typical response would be to refresh all labels by re-requesting them from the label provider.
labelProviderChanged in interface ILabelProviderListenerevent - the label provider change eventILabelProviderListener.labelProviderChanged(org.eclipse.jface.viewers.LabelProviderChangedEvent)public ITabDescriptor getSelectedTab()
null if there is no
tab selected.public ITabDescriptor[] getActiveTabs()
public void setSelectedTab(String id)
id - The string id of the tab to select.public String getTitleText(ISelection selection)
selection - Selection whose properties title text is to be returned
public Image getTitleImage(ISelection selection)
selection - Selection whose properties title image is to be returned
|
Eclipse Platform Release 3.7 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2011. All rights reserved.