Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 


Eclipse Platform
Release 3.5

org.eclipse.ui.views.properties.tabbed
Class TabbedPropertySheetPage

java.lang.Object
  extended by 

org.eclipse.ui.part.Page
      extended by 
org.eclipse.ui.views.properties.tabbed.TabbedPropertySheetPage
All Implemented Interfaces:
EventListener, ILabelProviderListener, ISelectionListener, IPage, IPageBookViewPage, IPropertySheetPage

public class TabbedPropertySheetPage
extends Page
implements IPropertySheetPage, ILabelProviderListener

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

tabListContentProvider

protected 
IStructuredContentProvider tabListContentProvider
Constructor Detail

TabbedPropertySheetPage

public TabbedPropertySheetPage(
ITabbedPropertySheetPageContributor tabbedPropertySheetPageContributor)
create a new tabbed property sheet page.

Parameters:
tabbedPropertySheetPageContributor - the tabbed property sheet page contributor.

TabbedPropertySheetPage

public TabbedPropertySheetPage(
ITabbedPropertySheetPageContributor tabbedPropertySheetPageContributor,
                               boolean showTitleBar)
create a new tabbed property sheet page.

Parameters:
tabbedPropertySheetPageContributor - the tabbed property sheet page contributor.
showTitleBar - boolean indicating if the title bar should be shown; default value is true
Since:
3.5
Method Detail

handlePartActivated

protected void handlePartActivated(
IWorkbenchPart part)
Handle the part activated event.

Parameters:
part - the new activated part.

createControl

public void createControl(
Composite parent)
Description copied from interface: IPage
Creates the SWT control for this page under the given parent control.

Clients should not call this method (the workbench calls this method when it needs to, which may be never).

Specified by:
createControl in interface IPage
Specified by:
createControl in class Page
Parameters:
parent - the parent control
See Also:
IPage.createControl(org.eclipse.swt.widgets.Composite)

getTabListContentProvider

protected 
IStructuredContentProvider getTabListContentProvider()
Gets the tab list content provider for the contributor.

Returns:
the tab list content provider for the contributor.

dispose

public void dispose()
Description copied from class: Page
The Page 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.

Specified by:
dispose in interface IPage
Overrides:
dispose in class Page
See Also:
IPage.dispose()

getControl

public 
Control getControl()
Description copied from class: Page
The Page implementation of this IPage method returns null. Subclasses must reimplement.

Specified by:
getControl in interface IPage
Specified by:
getControl in class Page
Returns:
the SWT control for this page, or null if this page does not have a control
See Also:
IPage.getControl()

setActionBars

public void setActionBars(
IActionBars actionBars)
Description copied from interface: IPage
Allows the page to make contributions to the given action bars. The contributions will be visible when the page is visible.

This method is automatically called shortly after createControl is called

Specified by:
setActionBars in interface IPage
Overrides:
setActionBars in class Page
Parameters:
actionBars - the action bars for this page
See Also:
IPage.setActionBars(org.eclipse.ui.IActionBars)

setFocus

public void setFocus()
Description copied from class: Page
The Page implementation of this IPage method does nothing. Subclasses must implement.

Specified by:
setFocus in interface IPage
Specified by:
setFocus in class Page
See Also:
IPage.setFocus()

selectionChanged

public void selectionChanged(
IWorkbenchPart part,
                             
ISelection selection)
Description copied from interface: ISelectionListener
Notifies this listener that the selection has changed.

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.

Specified by:
selectionChanged in interface ISelectionListener
Parameters:
part - the workbench part containing the selection
selection - the current selection. This may be null if INullSelectionListener is implemented.
See Also:
ISelectionListener.selectionChanged(org.eclipse.ui.IWorkbenchPart, org.eclipse.jface.viewers.ISelection)

resizeScrolledComposite

public void resizeScrolledComposite()
Resize the scrolled composite enclosing the sections, which may result in the addition or removal of scroll bars.

Since:
3.5

updateTabs

protected void updateTabs(
ITabDescriptor[] descriptors)
Update the current tabs to represent the given input object. When tabs apply for both the old and new input they are reused otherwise they are disposed. If the current visible tab will not be reused (i.e. will be disposed) we have to send it an aboutToBeHidden() message.

Since:
3.4

createTab

protected 
TabContents createTab(
ITabDescriptor tabDescriptor)
Create the tab contents for the provided tab descriptor.

Parameters:
tabDescriptor - the tab descriptor.
Returns:
the tab contents.
Since:
3.4

refresh

public void refresh()
Refresh the currently active tab.


getCurrentTab

public 
TabContents getCurrentTab()
Get the currently active tab.

Returns:
the currently active tab.
Since:
3.4

addTabSelectionListener

public void addTabSelectionListener(
ITabSelectionListener listener)
Add a tab selection listener.

Parameters:
listener - a tab selection listener.

removeTabSelectionListener

public void removeTabSelectionListener(
ITabSelectionListener listener)
Remove a tab selection listener.

Parameters:
listener - a tab selection listener.

overrideTabs

public void overrideTabs()
Override the tabs with a new set of tabs. The tab list is obtained from the AbstractOverridableTabListPropertySection by the IOverridableTabListContentProvider.

Since:
3.4

getWidgetFactory

public 
TabbedPropertySheetWidgetFactory getWidgetFactory()
Get the widget factory.

Returns:
the widget factory.

labelProviderChanged

public void labelProviderChanged(
LabelProviderChangedEvent event)
Description copied from interface: ILabelProviderListener
Notifies this listener that the state of the label provider has changed in a way that affects the labels it computes.

A typical response would be to refresh all labels by re-requesting them from the label provider.

Specified by:
labelProviderChanged in interface ILabelProviderListener
Parameters:
event - the label provider change event
See Also:
ILabelProviderListener.labelProviderChanged(org.eclipse.jface.viewers.LabelProviderChangedEvent)

getSelectedTab

public 
ITabDescriptor getSelectedTab()
Returns the currently selected tab.

Returns:
the currently selected tab or null if there is no tab selected.
Since:
3.5

getActiveTabs

public 
ITabDescriptor[] getActiveTabs()
Returns the list of currently active tabs.

Returns:
the currently active tabs.
Since:
3.5

setSelectedTab

public void setSelectedTab(
String id)
Set the currently selected tab to be that of the provided tab id.

Parameters:
id - The string id of the tab to select.
Since:
3.5

getTitleText

public 
String getTitleText(
ISelection selection)
Returns text of the properties title for given selection. If selection is null, then currentSelection is used

Parameters:
selection - Selection whose properties title text is to be returned
Returns:
String representing title text.
Since:
3.5

getTitleImage

public 
Image getTitleImage(
ISelection selection)
Returns the title image for given selection. If selection is null, then currentSelection is used.

Parameters:
selection - Selection whose properties title image is to be returned
Returns:
Image that is used as a title image.
Since:
3.5

Eclipse Platform
Release 3.5

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.


 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire