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.menus
Class WorkbenchWindowControlContribution

java.lang.Object
  extended by 

org.eclipse.jface.action.ContributionItem
      extended by 

org.eclipse.jface.action.ControlContribution
          extended by org.eclipse.ui.internal.menus.InternalControlContribution
              extended by 
org.eclipse.ui.menus.WorkbenchWindowControlContribution
All Implemented Interfaces:
IContributionItem

public abstract class WorkbenchWindowControlContribution
extends org.eclipse.ui.internal.menus.InternalControlContribution

Abstract base class from which all controls contributions to the workbench through the 'org.eclipse.ui.menus' extension point must derive.

The extends the ControlContribution by adding accessor methods that provide extra state information about the placement of the control:

  • getWorkbenchWindow() - indicates which workbench window this control is being hosted by
  • getCurSide() - indicates which side of the workbench window the control is being displayed on

Since:
3.3
See Also:
ControlContribution

Constructor Summary
WorkbenchWindowControlContribution ()
          Default contstructor that allows the use of this class as the basis for XML contributions and will be used by the workbench implementation.
WorkbenchWindowControlContribution ( String id)
          Constructor for use by clients programmatically creating control contributions in the workbench.
 
Method Summary
 int getCurSide ()
           
 int getOrientation ()
           
  IWorkbenchWindow getWorkbenchWindow ()
           
 
Methods inherited from class org.eclipse.jface.action. ControlContribution
computeWidth, createControl, fill, fill, fill
 
Methods inherited from class org.eclipse.jface.action. ContributionItem
dispose, fill, getId, getParent, isDirty, isDynamic, isEnabled, isGroupMarker, isSeparator, isVisible, saveWidgetState, setId, setParent, setVisible, toString, update, update
 
Methods inherited from class java.lang. Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

WorkbenchWindowControlContribution

public WorkbenchWindowControlContribution()
Default contstructor that allows the use of this class as the basis for XML contributions and will be used by the workbench implementation. This is public only by necessity and should not be used outside of the workbench implemenation code.


WorkbenchWindowControlContribution

public WorkbenchWindowControlContribution(
String id)
Constructor for use by clients programmatically creating control contributions in the workbench.

Parameters:
id - The id of this contribution
Method Detail

getWorkbenchWindow

public final 
IWorkbenchWindow getWorkbenchWindow()
Overrides:
getWorkbenchWindow in class org.eclipse.ui.internal.menus.InternalControlContribution
Returns:
Returns the workbench window currently hosting the control.

getCurSide

public final int getCurSide()
Overrides:
getCurSide in class org.eclipse.ui.internal.menus.InternalControlContribution
Returns:
Returns the side of the workbench window that the control is currently being display on. This allows derivatives to tailor their created control based on the orientation...

getOrientation

public final int getOrientation()
Overrides:
getOrientation in class org.eclipse.ui.internal.menus.InternalControlContribution

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