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.part
Class PageSwitcher

java.lang.Object
  extended by 
org.eclipse.ui.part.PageSwitcher

public abstract class PageSwitcher
extends Object

Provides the implementation for switching pages in a view. A view may track pages however it wishes. The view should subclass PageSwitcher to provide the abstract methods, and then instantiate their page switcher once.

Since:
3.4

Constructor Summary
PageSwitcher ( IWorkbenchPart part)
          Register the handlers for page switching with this view or editor.
 
Method Summary
abstract  void activatePage ( Object page)
          Displays the given page in the view.
 int getCurrentPageIndex ()
          Returns the index of the currently active page.
abstract   ImageDescriptor getImageDescriptor ( Object page)
          Returns an ImageDescriptor for the page.
abstract   String getName ( Object page)
          Returns a readable name to identify the page.
abstract   Object[] getPages ()
          Returns the pages available in the view.
 
Methods inherited from class java.lang. Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PageSwitcher

public PageSwitcher(
IWorkbenchPart part)
Register the handlers for page switching with this view or editor.

Parameters:
part - The part to register against.
Method Detail

activatePage

public abstract void activatePage(
Object page)
Displays the given page in the view. The page must already exist in the view.

Parameters:
page - the page to display, never null.

getImageDescriptor

public abstract 
ImageDescriptor getImageDescriptor(
Object page)
Returns an ImageDescriptor for the page.

Parameters:
page - the page to retrieve an ImageDescriptor
Returns:
An ImageDescriptor for the page, may be null.

getName

public abstract 
String getName(
Object page)
Returns a readable name to identify the page.

Parameters:
page - the page to get the name
Returns:
the name of the page

getPages

public abstract 
Object[] getPages()
Returns the pages available in the view. These may be used for populating the pop-up dialog when switching pages. These are the objects that will be used in activatePage(Object).

Returns:
an array of pages

getCurrentPageIndex

public int getCurrentPageIndex()
Returns the index of the currently active page. The default implementation returns 0. Subclasses can override.

Returns:
the 0-based index of the currently active page from getPages(), or an arbitrary value if getPages() is an empty array.

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