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

  




 

 

RSE
Release 3.0

org.eclipse.rse.ui.view
Interface ISystemEditableRemoteObject

All Known Implementing Classes:
SystemEditableRemoteFile

public interface ISystemEditableRemoteObject

This interface defines some common functionality required from all remote resources for edit, irrespective of whether the remote system is an OS/400, Windows, Linux or Unix operating system.


Field Summary
static int NOT_OPEN
           
static int OPEN_IN_DIFFERENT_PERSPECTIVE
           
static int OPEN_IN_SAME_PERSPECTIVE
           
 
Method Summary
 void addAsListener ()
          Register as listener for various events
 int checkOpenInEditor ()
          Is the local file open in an editor
 boolean doImmediateSaveAndUpload ()
          Saves the local file and uploads it to the host immediately, rather than, in response to a resource change event.
 boolean download ( IProgressMonitor monitor)
          Download the file.
 boolean download ( Shell shell)
          Download the file.
 boolean exists ()
          Returns whether the edited object exists.
  String getAbsolutePath ()
          Return the absolute path on the remote system.
  IEditorPart getEditorPart ()
          Returns the open IEditorPart for this remote object if there is one.
  IFile getLocalResource ()
          Get the local resource
  IAdaptable getRemoteObject ()
          Returns the remote object that is editable
  ISubSystem getSubSystem ()
          Return the subsystem for the edited object.
 boolean isDirty ()
          Check if the file is dirty
 boolean isReadOnly ()
          Check if user has write authority to the file.
 boolean isStale ()
          Returns whether the underlying resource needs to be updated from the host
 void open (boolean readOnly, IProgressMonitor monitor)
          Open in editor
 void open ( IProgressMonitor monitor)
          Open in editor
 void open ( Shell shell)
          Open in editor
 void open ( Shell shell, boolean readOnly)
          Open in editor
 void openEditor ()
          Open the editor
 void setEditor ( IEditorPart editorPart)
          Set the editor variable given an exiting editor part
 void setLocalResourceProperties ()
          Set local resource properties
 void setReadOnly (boolean isReadOnly)
          Indicate whether the file can be edited
 void updateDirtyIndicator ()
          Update the editor dirty indicator
 

Field Detail

NOT_OPEN

static final int NOT_OPEN
See Also:
Constant Field Values

OPEN_IN_SAME_PERSPECTIVE

static final int OPEN_IN_SAME_PERSPECTIVE
See Also:
Constant Field Values

OPEN_IN_DIFFERENT_PERSPECTIVE

static final int OPEN_IN_DIFFERENT_PERSPECTIVE
See Also:
Constant Field Values
Method Detail

isReadOnly

boolean isReadOnly()
Check if user has write authority to the file.

Returns:
true if user has write authority to the file, false otherwise

setReadOnly

void setReadOnly(boolean isReadOnly)
Indicate whether the file can be edited


setEditor

void setEditor(
IEditorPart editorPart)
Set the editor variable given an exiting editor part

Parameters:
editorPart - the editor

download

boolean download(
Shell shell)
                 throws 
Exception
Download the file.

Parameters:
shell - if the shell is null, no progress monitor will be shown
Returns:
true if successful, false if cancelled
Throws:
Exception

download

boolean download(
IProgressMonitor monitor)
                 throws 
Exception
Download the file.

Parameters:
monitor - the progress monitor
Returns:
true if the operation was successful. false if the user cancels.
Throws:
Exception

doImmediateSaveAndUpload

boolean doImmediateSaveAndUpload()
Saves the local file and uploads it to the host immediately, rather than, in response to a resource change event.

Returns:
true if the operation was successful. false if the upload fails.

getLocalResource

IFile getLocalResource()
Get the local resource


checkOpenInEditor

int checkOpenInEditor()
                      throws 
CoreException
Is the local file open in an editor

Throws:
CoreException

getEditorPart

IEditorPart getEditorPart()
Returns the open IEditorPart for this remote object if there is one.


getRemoteObject

IAdaptable getRemoteObject()
Returns the remote object that is editable


open

void open(
Shell shell)
Open in editor


open

void open(
Shell shell,
          boolean readOnly)
Open in editor


open

void open(
IProgressMonitor monitor)
Open in editor


open

void open(boolean readOnly,
          
IProgressMonitor monitor)
Open in editor


setLocalResourceProperties

void setLocalResourceProperties()
                                throws 
Exception
Set local resource properties

Throws:
Exception

addAsListener

void addAsListener()
Register as listener for various events


openEditor

void openEditor()
                throws 
PartInitException
Open the editor

Throws:
PartInitException

updateDirtyIndicator

void updateDirtyIndicator()
Update the editor dirty indicator


isDirty

boolean isDirty()
Check if the file is dirty


getAbsolutePath

String getAbsolutePath()
Return the absolute path on the remote system.


getSubSystem

ISubSystem getSubSystem()
Return the subsystem for the edited object.


exists

boolean exists()
Returns whether the edited object exists.


isStale

boolean isStale()
Returns whether the underlying resource needs to be updated from the host


RSE
Release 3.0

Copyright (c) IBM Corporation and others 2000, 2008. All Rights Reserved.

 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire