Eclipse Platform
Release 3.4

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

java.lang.Object
  extended byorg.eclipse.ui.views.properties.tabbed.TabContents

public final class TabContents
extends Object

A property tab is composed by one or more property sections and is used to categorize sections.

Since:
3.4

Constructor Summary
TabContents()
           
 
Method Summary
 void aboutToBeHidden()
          Sends the lifecycle event to the page's sections.
 void aboutToBeShown()
          Sends the lifecycle event to the page's sections.
 boolean controlsHaveBeenCreated()
          Determine if the controls have been created.
 void createControls(Composite parent, TabbedPropertySheetPage page)
          Creates page's sections controls.
 void dispose()
          Dispose of page's sections controls.
 ISection getSectionAtIndex(int i)
          Retrieve the section at a numbered index.
 int getSectionIndex(ISection section)
          Retrieve a numbered index for the section.
 ISection[] getSections()
          Retrieve the sections on the tab.
 void refresh()
          If controls have been created, refresh all sections on the page.
 void setInput(IWorkbenchPart part, ISelection selection)
          Sets page's sections input objects.
 void setSections(ISection[] sections)
          Set the sections for the tab.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TabContents

public TabContents()
Method Detail

getSectionIndex

public int getSectionIndex(ISection section)
Retrieve a numbered index for the section.

Parameters:
section - the section.
Returns:
the section index.

getSectionAtIndex

public ISection getSectionAtIndex(int i)
Retrieve the section at a numbered index.

Parameters:
i - a numbered index.
Returns:
the section.

getSections

public ISection[] getSections()
Retrieve the sections on the tab.

Returns:
the sections on the tab.

createControls

public void createControls(Composite parent,
                           TabbedPropertySheetPage page)
Creates page's sections controls.

Parameters:
parent -
page -

dispose

public void dispose()
Dispose of page's sections controls.


aboutToBeShown

public void aboutToBeShown()
Sends the lifecycle event to the page's sections.


aboutToBeHidden

public void aboutToBeHidden()
Sends the lifecycle event to the page's sections.


setInput

public void setInput(IWorkbenchPart part,
                     ISelection selection)
Sets page's sections input objects.

Parameters:
part -
selection -

setSections

public void setSections(ISection[] sections)
Set the sections for the tab.

Parameters:
sections - the sections for the tab.

controlsHaveBeenCreated

public boolean controlsHaveBeenCreated()
Determine if the controls have been created.

Returns:
true if controls have been created.

refresh

public void refresh()
If controls have been created, refresh all sections on the page.


Eclipse Platform
Release 3.4

Guidelines for using Eclipse APIs.

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