Eclipse Plug-in Developer Guide (Galileo) - ReadOnlyStateChecker (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.ui.actions
Class ReadOnlyStateChecker


java.lang.Object
  
org.eclipse.ui.actions.ReadOnlyStateChecker

public class ReadOnlyStateChecker
extends Object
extends Object

The ReadOnlyStateChecker is a helper class that takes a set of resource some of which may be read only and queries the user as to whether or not they wish to continue the operation on it.

Constructor Summary

ReadOnlyStateChecker ( Shell parent, String title, String message)
          Create a new checker that parents the dialog off of parent using the supplied title and message.

Method Summary

IResource[] checkReadOnlyResources ( IResource[] itemsToCheck)
          Check the supplied resources to see if they are read only.

boolean getIgnoreLinkedResources ()
          Returns whether to ignore linked resources.

void setIgnoreLinkedResources (boolean ignore)
          Sets whether to ignore linked resources.

Methods inherited from class java.lang. Object

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

Constructor Detail

ReadOnlyStateChecker

public ReadOnlyStateChecker(
Shell parent,
                            
String title,
                            
String message)

Create a new checker that parents the dialog off of parent using the supplied title and message.

Parameters:: parent - the shell used for dialogs; title - the title for dialogs; message - the message for a dialog - this will be prefaced with the name of the resource.

Method Detail

checkReadOnlyResources

public 
IResource[] checkReadOnlyResources(
IResource[] itemsToCheck)

Check the supplied resources to see if they are read only. If so then prompt the user to see if they can be deleted.Return those that were accepted.

Parameters:: itemsToCheck -
Returns:: the resulting selected resources

getIgnoreLinkedResources

public boolean getIgnoreLinkedResources()

Returns whether to ignore linked resources.

Returns:: true to ignore linked resources, false to consider them
Since:: 3.1

setIgnoreLinkedResources

public void setIgnoreLinkedResources(boolean ignore)

Sets whether to ignore linked resources. The default is false.

Parameters:: ignore - true to ignore linked resources, false to consider them
Since:: 3.1