|
RSE Release 3.4 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.eclipse.rse.files.ui.resources.SystemEditableRemoteFile
public class SystemEditableRemoteFile
| Nested Class Summary | |
|---|---|
class |
SystemEditableRemoteFile.DisplayMessageDialog
|
class |
SystemEditableRemoteFile.DisplayQuestionDialog
|
| Field Summary |
|---|
| Fields inherited from interface org.eclipse.rse.ui.view.ISystemEditableRemoteObject |
|---|
NOT_OPEN, OPEN_IN_DIFFERENT_PERSPECTIVE, OPEN_IN_SAME_PERSPECTIVE |
| Constructor Summary | |
|---|---|
SystemEditableRemoteFile(IRemoteFile remoteFile)
Constructor for SystemEditableRemoteFile |
|
SystemEditableRemoteFile(IRemoteFile remoteFile,
IEditorDescriptor editorDescriptor)
Constructor for SystemEditableRemoteFile |
|
SystemEditableRemoteFile(IWorkbenchPage page,
IRemoteFile remoteFile,
IEditorDescriptor editorDescriptor)
Constructor for SystemEditableRemoteFile |
|
| Method Summary | |
|---|---|
void |
addAsListener()
Register as listener for various events |
int |
checkOpenInEditor()
Is the local file open in an editor |
void |
delete()
Delete the local resource |
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. |
String |
getActualHostFor(String remotePath)
|
protected IEditorDescriptor |
getDefaultTextEditor()
|
IEditorPart |
getEditor()
Get the editor |
IEditorDescriptor |
getEditorDescriptor()
Get the editor descriptor to be associated with the remote file |
IEditorPart |
getEditorPart()
Returns the open IEditorPart for this remote object if there is one. |
protected IEditorRegistry |
getEditorRegistry()
|
static SystemEditableRemoteFile |
getInstance(IFile file)
Returns an instance of this class given a local copy of a remote file. |
String |
getLocalPath()
Get the local path |
IFile |
getLocalResource()
Get the local resource |
IRemoteFile |
getRemoteFile()
Get the remote file |
IAdaptable |
getRemoteObject()
Returns the remote object that is editable |
ISubSystem |
getSubSystem()
Return the subsystem for the edited object. |
String |
getWorkspaceRemotePath(String remotePath)
Gets the path to use in the workspace for saving the local replica remote file. |
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 |
openInInPlaceEditor(Shell shell)
Open in in place editor |
void |
openInSystemEditor(Shell shell)
Open in system editor |
void |
openSystemEditor()
Open the system editor |
void |
partActivated(IWorkbenchPart part)
|
void |
partBroughtToTop(IWorkbenchPart part)
|
void |
partClosed(IWorkbenchPart part)
|
void |
partDeactivated(IWorkbenchPart part)
|
void |
partOpened(IWorkbenchPart part)
|
void |
resourceChanged(IResourceChangeEvent event)
|
boolean |
saveAs(IRemoteFile newRemoteFile,
IProgressMonitor progressMonitor)
Save as to a remote location |
void |
setEditor(IEditorPart editor)
Set the editor |
void |
setEditorDescriptor(IEditorDescriptor descriptor)
Set the editor descriptor to be associated with the remote file |
void |
setLocalPath(String localPath)
Set the local path |
void |
setLocalResourceProperties()
Set local resource properties |
void |
setReadOnly(boolean isReadOnly)
Indicate whether the file can be edited |
protected void |
setReadOnly(IFile file,
boolean flag)
|
void |
setRemoteFile(IRemoteFile remoteFile)
Set the remote file |
void |
updateDirtyIndicator()
Update the editor dirty indicator |
boolean |
visit(IResourceDelta delta)
|
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public SystemEditableRemoteFile(IWorkbenchPage page,
IRemoteFile remoteFile,
IEditorDescriptor editorDescriptor)
public SystemEditableRemoteFile(IRemoteFile remoteFile,
IEditorDescriptor editorDescriptor)
public SystemEditableRemoteFile(IRemoteFile remoteFile)
| Method Detail |
|---|
protected IEditorRegistry getEditorRegistry()
protected IEditorDescriptor getDefaultTextEditor()
public static SystemEditableRemoteFile getInstance(IFile file)
file - the local file to create it from.public void setRemoteFile(IRemoteFile remoteFile)
public IRemoteFile getRemoteFile()
public void setLocalPath(String localPath)
public String getLocalPath()
public void setEditor(IEditorPart editor)
setEditor in interface ISystemEditableRemoteObjecteditor - the editorpublic IEditorPart getEditor()
public boolean isReadOnly()
isReadOnly in interface ISystemEditableRemoteObjectpublic void setReadOnly(boolean isReadOnly)
setReadOnly in interface ISystemEditableRemoteObject
public boolean download(Shell shell)
throws Exception
download in interface ISystemEditableRemoteObjectshell - if the shell is null, no progress monitor will be shown
Exception
protected void setReadOnly(IFile file,
boolean flag)
public boolean download(IProgressMonitor monitor)
throws Exception
download in interface ISystemEditableRemoteObjectmonitor - the progress monitor
Exceptionpublic boolean doImmediateSaveAndUpload()
doImmediateSaveAndUpload in interface ISystemEditableRemoteObjectpublic IFile getLocalResource()
getLocalResource in interface ISystemEditableRemoteObjectpublic void delete()
public String getWorkspaceRemotePath(String remotePath)
remotePath - the absolute path to the resource on the host
public String getActualHostFor(String remotePath)
public IEditorPart getEditorPart()
getEditorPart in interface ISystemEditableRemoteObjectpublic IAdaptable getRemoteObject()
getRemoteObject in interface ISystemEditableRemoteObjectpublic int checkOpenInEditor()
checkOpenInEditor in interface ISystemEditableRemoteObjectpublic void open(Shell shell)
open in interface ISystemEditableRemoteObject
public void open(Shell shell,
boolean readOnly)
open in interface ISystemEditableRemoteObjectpublic void open(IProgressMonitor monitor)
open in interface ISystemEditableRemoteObject
public void open(boolean readOnly,
IProgressMonitor monitor)
open in interface ISystemEditableRemoteObjectpublic void openInSystemEditor(Shell shell)
public void openInInPlaceEditor(Shell shell)
public void setLocalResourceProperties()
throws CoreException
setLocalResourceProperties in interface ISystemEditableRemoteObjectCoreExceptionpublic void addAsListener()
addAsListener in interface ISystemEditableRemoteObject
public void openEditor()
throws PartInitException
openEditor in interface ISystemEditableRemoteObjectPartInitException
public void openSystemEditor()
throws PartInitException
PartInitExceptionpublic void partActivated(IWorkbenchPart part)
partActivated in interface IPartListenerIPartListener.partActivated(IWorkbenchPart)public void partBroughtToTop(IWorkbenchPart part)
partBroughtToTop in interface IPartListenerIPartListener.partBroughtToTop(IWorkbenchPart)public void partClosed(IWorkbenchPart part)
partClosed in interface IPartListenerIPartListener.partClosed(IWorkbenchPart)public void partDeactivated(IWorkbenchPart part)
partDeactivated in interface IPartListenerIPartListener.partDeactivated(IWorkbenchPart)public void partOpened(IWorkbenchPart part)
partOpened in interface IPartListenerIPartListener.partOpened(IWorkbenchPart)public void resourceChanged(IResourceChangeEvent event)
resourceChanged in interface IResourceChangeListenerIResourceChangeListener.resourceChanged(IResourceChangeEvent)
public boolean visit(IResourceDelta delta)
throws CoreException
visit in interface IResourceDeltaVisitorCoreExceptionIResourceDeltaVisitor.visit(IResourceDelta)
public boolean saveAs(IRemoteFile newRemoteFile,
IProgressMonitor progressMonitor)
public void updateDirtyIndicator()
ISystemEditableRemoteObject
updateDirtyIndicator in interface ISystemEditableRemoteObjectpublic boolean isDirty()
ISystemEditableRemoteObject
isDirty in interface ISystemEditableRemoteObjectpublic String getAbsolutePath()
ISystemEditableRemoteObject
getAbsolutePath in interface ISystemEditableRemoteObjectpublic ISubSystem getSubSystem()
ISystemEditableRemoteObject
getSubSystem in interface ISystemEditableRemoteObjectpublic boolean exists()
ISystemEditableRemoteObject
exists in interface ISystemEditableRemoteObjectpublic boolean isStale()
ISystemEditableRemoteObject
isStale in interface ISystemEditableRemoteObjectpublic IEditorDescriptor getEditorDescriptor()
public void setEditorDescriptor(IEditorDescriptor descriptor)
descriptor - the new editor descriptor
|
RSE Release 3.4 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||