|
RSE Release 3.4 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
---|
static final int NOT_OPEN
static final int OPEN_IN_SAME_PERSPECTIVE
static final int OPEN_IN_DIFFERENT_PERSPECTIVE
Method Detail |
---|
boolean isReadOnly()
void setReadOnly(boolean isReadOnly)
void setEditor(IEditorPart editorPart)
editorPart
- the editorboolean download(Shell shell) throws Exception
shell
- if the shell is null, no progress monitor will be shown
Exception
boolean download(IProgressMonitor monitor) throws Exception
monitor
- the progress monitor
Exception
boolean doImmediateSaveAndUpload()
IFile getLocalResource()
int checkOpenInEditor() throws CoreException
CoreException
IEditorPart getEditorPart()
IAdaptable getRemoteObject()
void open(Shell shell)
void open(Shell shell, boolean readOnly)
void open(IProgressMonitor monitor)
void open(boolean readOnly, IProgressMonitor monitor)
void setLocalResourceProperties() throws Exception
Exception
void addAsListener()
void openEditor() throws PartInitException
PartInitException
void updateDirtyIndicator()
boolean isDirty()
String getAbsolutePath()
ISubSystem getSubSystem()
boolean exists()
boolean isStale()
|
RSE Release 3.4 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |