| java.lang.Object
 org.eclipse.ui.internal.presentations.PaneFolder
| PaneFolder | | final public class PaneFolder (Code) | | This class implements the tab folders that contains can contain two toolbars
and status text. Wherever possible, the toolbars are aligned with the tabs.
If there is not enough room beside the tabs, the toolbars are aligned with
the status text. This is the same tab folder that is used to arrange views
and editors in Eclipse.
This is closely related to DefaultPartPresentation, but they have different
responsibilities. This is essentially a CTabFolder that can manage a toolbar.
It should not depend on data structures from the workbench, and its public
interface should only use SWT objects or listeners. DefaultPartPresentation
uses a PaneFolder to arrange views or editors. Knowledge of higher-level data
structures should go there.
Although it is not actually a control, the public interface is much like an
SWT control. Implementation-wise, this is actually a combination of a
CTabFolder and a ViewForm. It encapsulates the details of moving the toolbar
between the CTabFolder and the ViewForm, and provides a simpler interface to
the ViewForm/CTabFolder.
To be consistent with SWT composites, this object can deal with its children
being disposed without warning. This is treated like a removal.
since:
3.0 |
| Constructor Summary | |
| public | PaneFolder(Composite parent, int flags)
Creates a pane folder. |
| PaneFolder | | public PaneFolder(Composite parent, int flags)(Code) | | Creates a pane folder. This will create exactly one child control in the
given parent.
Parameters:
parent -
Parameters:
flags - |
| aboutToResize | | public void aboutToResize()(Code) | | Optimization: calling this method immediately before setting the
control's bounds will allow for improved caching.
|
| computeMinimumSize | | public Point computeMinimumSize()(Code) | | |
| computeTrim | | public Rectangle computeTrim(int i, int j, int k, int l)(Code) | |
Parameters:
i -
Parameters:
j -
Parameters:
k -
Parameters:
l - |
| createItem | | public CTabItem createItem(int style, int index)(Code) | | |
| flushTopCenterSize | | public void flushTopCenterSize()(Code) | | |
| getChevronLocation | | public Point getChevronLocation()(Code) | | |
| getContent | | public Control getContent()(Code) | | |
| getContentParent | | public Composite getContentParent()(Code) | | |
| getControl | | public Composite getControl()(Code) | | Return the main control for this pane folder
|
| getItem | | public CTabItem getItem(int idx)(Code) | | |
| getItem | | public CTabItem getItem(Point toGet)(Code) | | |
| getItemCount | | public int getItemCount()(Code) | | |
| getItems | | public CTabItem[] getItems()(Code) | | |
| getSelection | | public CTabItem getSelection()(Code) | | |
| getSelectionIndex | | public int getSelectionIndex()(Code) | | |
| getState | | public int getState()(Code) | | Returns the current state of the folder (as shown on the button icons)
one of the IStackPresentationSite.STATE_* constants |
| getTabHeight | | public int getTabHeight()(Code) | | |
| getTabPosition | | public int getTabPosition()(Code) | | |
| getTitleArea | | public Rectangle getTitleArea()(Code) | | Returns the title area (the empty region to the right of the tabs), in
the tab folder's coordinate system.
the title area (the empty region to the right of the tabs) |
| getViewForm | | public ViewForm getViewForm()(Code) | | |
| hideTitle | | public void hideTitle()(Code) | | |
| indexOf | | public int indexOf(CTabItem toFind)(Code) | | |
| isDisposed | | public boolean isDisposed()(Code) | | |
| layout | | public void layout(boolean flushCache)(Code) | | |
| notifyButtonListeners | | protected void notifyButtonListeners(int buttonId)(Code) | |
Parameters:
buttonId - one of the IStackPresentationSite.STATE_* constants |
| notifyCloseListeners | | protected void notifyCloseListeners(CTabItem tabItem)(Code) | | Notifies all listeners that the close button was pressed
Parameters:
tabItem - |
| notifyShowListeners | | protected void notifyShowListeners(CTabFolderEvent event)(Code) | | Notifies all listeners that the user clicked on the chevron
Parameters:
tabItem - |
| setContent | | public void setContent(Control newContent)(Code) | | |
| setMaximizeVisible | | public void setMaximizeVisible(boolean isVisible)(Code) | |
Parameters:
isVisible - |
| setMinimizeVisible | | public void setMinimizeVisible(boolean isVisible)(Code) | |
Parameters:
isVisible - |
| setMinimumCharacters | | public void setMinimumCharacters(int count)(Code) | | Changes the minimum number of characters to display in a pane folder tab.
This control how much information will be displayed to the user.
Parameters:
count - The number of characters to display in the tab folder; thisvalue should be a positive integer.
See Also: org.eclipse.swt.custom.CTabFolder.setMinimumCharacters(int)
since:
3.1 |
| setSelection | | public void setSelection(int selection)(Code) | | |
| setSelectionBackground | | public void setSelectionBackground(Color[] bgColors, int[] percentages, boolean vertical)(Code) | |
Parameters:
bgColors -
Parameters:
percentages -
Parameters:
vertical - |
| setSelectionForeground | | public void setSelectionForeground(Color fgColor)(Code) | |
Parameters:
fgColor - |
| setSimpleTab | | public void setSimpleTab(boolean traditionalTab)(Code) | |
Parameters:
traditionalTab - |
| setSingleTab | | public void setSingleTab(boolean b)(Code) | |
Parameters:
b - |
| setState | | public void setState(int state)(Code) | | Sets the state that will be shown on the CTabFolder's buttons
Parameters:
state - one of the IStackPresentationSite.STATE_* constants |
| setTabHeight | | public void setTabHeight(int height)(Code) | | |
| setTabPosition | | public void setTabPosition(int newTabPosition)(Code) | | |
| setTopCenter | | public void setTopCenter(Control topCenter)(Code) | | Sets the top-center control (usually a toolbar), or null if none. Note
that the control can have any parent.
Parameters:
topCenter - the top-center control or null if none |
| setTopLeft | | public void setTopLeft(Control topLeft)(Code) | | Sets the top-left control (usually a title label), or null if none
Parameters:
topLeft - |
| setTopRight | | public void setTopRight(Control topRight)(Code) | | Sets the top-right control (usually a dropdown), or null if none
Parameters:
topRight - |
| setUnselectedCloseVisible | | public void setUnselectedCloseVisible(boolean b)(Code) | |
Parameters:
b - |
| setUnselectedImageVisible | | public void setUnselectedImageVisible(boolean b)(Code) | |
Parameters:
b - |
| setVisible | | public void setVisible(boolean visible)(Code) | | Propogate the visibility change requests to the proxy controls. When
their target is null, they no longer get visibility updates. Currently
this only propagates the changes to the ProxyControls held by this
folder.
Parameters:
visible - true - it's visible.
since:
3.2 |
| showMinMax | | public void showMinMax(boolean show)(Code) | | Cause the folder to hide or show its
Minimize and Maximize affordances.
Parameters:
show - true - the min/max buttons are visible.
since:
3.3 |
|
|