Eclipse Plug-in Developer Guide (Galileo) - SourceLookupTab (Eclipse Platform API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.debug.ui.sourcelookup
Class SourceLookupTab


java.lang.Object
  

org.eclipse.debug.ui.AbstractLaunchConfigurationTab
      
org.eclipse.debug.ui.sourcelookup.SourceLookupTab

All Implemented Interfaces:: ILaunchConfigurationTab

public class SourceLookupTab
extends AbstractLaunchConfigurationTab
extends AbstractLaunchConfigurationTab

A launch configuration tab that displays and edits the source lookup path for a launch configuration. This tab works with the debug platform source lookup facilities - a source lookup director with associated participants and source containers.

This tab may be instantiated.

Since:: 3.0
Restriction:: This class is not intended to be subclassed by clients.

Constructor Summary

SourceLookupTab ()


Method Summary

void activated ( ILaunchConfigurationWorkingCopy workingCopy)
          This method was added to the ILaunchConfigurationTab interface in the 3.0 release to allow tabs to distinguish between a tab being activated and a tab group be initialized for the first time, from a selected launch configuration.

void createControl ( Composite parent)
          Creates the top level control for this launch configuration tab under the given parent composite.

void dispose ()
          By default, do nothing.

String getErrorMessage ()
          Returns the current error message for this tab.

String getId ()
          Returns this tab's unique identifier or null if none.

Image getImage ()
          Returns the image for this tab, or null if none

String getMessage ()
          Returns the current message for this tab.

String getName ()
          Returns the name of this tab.

void initializeFrom ( ILaunchConfiguration configuration)
          Initializes this tab's controls with values from the given launch configuration.

void performApply ( ILaunchConfigurationWorkingCopy configuration)
          Copies values from this tab into the given launch configuration.

void setDefaults ( ILaunchConfigurationWorkingCopy configuration)
          Initializes the given launch configuration with default values for this tab.

Methods inherited from class org.eclipse.debug.ui. AbstractLaunchConfigurationTab

canSave, createCheckButton, createPushButton, createRadioButton, createSeparator, createVerticalSpacer, deactivated, getControl, getLaunchConfigurationDialog, getLaunchManager, getShell, isDirty, isValid, launched, setAttribute, setControl, setDirty, setErrorMessage, setLaunchConfigurationDialog, setMessage, updateLaunchConfigurationDialog

Methods inherited from class java.lang. Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SourceLookupTab

public SourceLookupTab()

Method Detail

createControl

public void createControl(
Composite parent)

Description copied from interface: ILaunchConfigurationTab

Creates the top level control for this launch configuration tab under the given parent composite. This method is called once on tab creation, after setLaunchConfigurationDialog is called.

Implementors are responsible for ensuring that the created control can be accessed via getControl

Parameters:: parent - the parent composite

setDefaults

public void setDefaults(
ILaunchConfigurationWorkingCopy configuration)

Description copied from interface: ILaunchConfigurationTab

Initializes the given launch configuration with default values for this tab. This method is called when a new launch configuration is created such that the configuration can be initialized with meaningful values. This method may be called before this tab's control is created.

Parameters:: configuration - launch configuration

initializeFrom

public void initializeFrom(
ILaunchConfiguration configuration)

Description copied from interface: ILaunchConfigurationTab

Initializes this tab's controls with values from the given launch configuration. This method is called when a configuration is selected to view or edit, after this tab's control has been created.

Parameters:: configuration - launch configuration

performApply

public void performApply(
ILaunchConfigurationWorkingCopy configuration)

Description copied from interface: ILaunchConfigurationTab

Copies values from this tab into the given launch configuration.

Parameters:: configuration - launch configuration

getId

public 
String getId()

Description copied from class: AbstractLaunchConfigurationTab

Returns this tab's unique identifier or null if none. By default, null is returned. Subclasses should override as necessary.

Tab identifiers allow contributed tabs to be ordered relative to one another.

Overrides:: getId in class AbstractLaunchConfigurationTab

Returns:: tab id or null

getName

public 
String getName()

Description copied from interface: ILaunchConfigurationTab

Returns the name of this tab.

Returns:: the name of this tab

getImage

public 
Image getImage()

Description copied from interface: ILaunchConfigurationTab

Returns the image for this tab, or null if none

Specified by:: getImage in interface ILaunchConfigurationTab
Overrides:: getImage in class AbstractLaunchConfigurationTab

Returns:: the image for this tab, or null if none
See Also:: ILaunchConfigurationTab.getImage()

activated

public void activated(
ILaunchConfigurationWorkingCopy workingCopy)

Description copied from class: AbstractLaunchConfigurationTab

This method was added to the ILaunchConfigurationTab interface in the 3.0 release to allow tabs to distinguish between a tab being activated and a tab group be initialized for the first time, from a selected launch configuration. To maintain backwards compatible behavior, the default implementation provided, calls this tab's initializeFrom method. Tabs should override this method as required.

The launch tab framework was originally designed to take care of inter tab communication by applying attributes from the active tab to the launch configuration being edited, when a tab is exited, and by initializing a tab when activated. The addition of the methods activated and deactivated allow tabs to determine the appropriate course of action.