Eclipse Plug-in Developer Guide (Galileo) - RefreshTab (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
Class RefreshTab


java.lang.Object
  

org.eclipse.debug.ui.AbstractLaunchConfigurationTab
      
org.eclipse.debug.ui.RefreshTab

All Implemented Interfaces:: ILaunchConfigurationTab

public class RefreshTab
extends AbstractLaunchConfigurationTab
extends AbstractLaunchConfigurationTab

A launch configuration tab which allows the user to specify which resources should be refreshed when the launch terminates.

This class may be instantiate.

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

Field Summary

static String ATTR_REFRESH_RECURSIVE
          Boolean attribute indicating if a refresh scope is recursive.

static String ATTR_REFRESH_SCOPE
          String attribute identifying the scope of resources that should be refreshed after an external tool is run.

Constructor Summary

RefreshTab ()


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 deactivated ( ILaunchConfigurationWorkingCopy workingCopy)
          This method was added to the ILaunchConfigurationTab interface in the 3.0 release to allow tabs to distinguish between a tab being deactivated and saving its attributes to a launch configuration.

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 getName ()
          Returns the name of this tab.

static String getRefreshAttribute ( IWorkingSet workingSet)
          Creates and returns a memento for the given working set, to be used as a refresh attribute.

static IResource[] getRefreshResources ( String scope)
          Returns a collection of resources referred to by a refresh scope attribute.

static String getRefreshScope ( ILaunchConfiguration configuration)
          Returns the refresh scope attribute specified by the given launch configuration or null if none.

static IWorkingSet getWorkingSet ( String refreshAttribute)
          Creates and returns a working set from the given refresh attribute created by the method getRefreshAttribute(IWorkingSet), or null if none.

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

static boolean isRefreshRecursive ( ILaunchConfiguration configuration)
          Returns whether the refresh scope specified by the given launch configuration is recursive.

boolean isValid ( ILaunchConfiguration launchConfig)
          Returns whether this tab is in a valid state in the context of the specified launch configuration.

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

static void refreshResources ( ILaunchConfiguration configuration, IProgressMonitor monitor)
          Refreshes the resources as specified by 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, dispose, getControl, getErrorMessage, getLaunchConfigurationDialog, getLaunchManager, getMessage, getShell, isDirty, 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

Field Detail

ATTR_REFRESH_RECURSIVE

public static final 
String ATTR_REFRESH_RECURSIVE

Boolean attribute indicating if a refresh scope is recursive. Default value is false.

ATTR_REFRESH_SCOPE

public static final 
String ATTR_REFRESH_SCOPE

String attribute identifying the scope of resources that should be refreshed after an external tool is run. The value is either a refresh variable or the default value, null, indicating no refresh.

Constructor Detail

RefreshTab

public RefreshTab()

Method Detail