org.eclipse.ecf.filetransfer.ui.actions
Class AbstractFileSendAction

java.lang.Object
  extended by org.eclipse.core.commands.common.EventManager
      extended by org.eclipse.jface.action.AbstractAction
          extended by org.eclipse.jface.action.Action
              extended by org.eclipse.ecf.filetransfer.ui.actions.AbstractFileSendAction
All Implemented Interfaces:
org.eclipse.jface.action.IAction

public abstract class AbstractFileSendAction
extends org.eclipse.jface.action.Action

Action super class for initiating outging file transfers. Subclasses should be created to implement getOutgoingFileTransferAdapter() and to override any desired methods.


Field Summary
protected  IExceptionHandler exceptionHandler
           
protected  IFileTransferInfo fileTransferInfo
           
protected  IFileTransferListener fileTransferListener
           
protected  java.util.Map options
           
protected  IFileID targetReceiver
           
 
Fields inherited from interface org.eclipse.jface.action.IAction
AS_CHECK_BOX, AS_DROP_DOWN_MENU, AS_PUSH_BUTTON, AS_RADIO_BUTTON, AS_UNSPECIFIED, CHECKED, DESCRIPTION, ENABLED, HANDLED, IMAGE, RESULT, TEXT, TOOL_TIP_TEXT
 
Constructor Summary
AbstractFileSendAction()
           
 
Method Summary
protected  IFileTransferListener createDefaultFileTransferListener()
           
 IExceptionHandler getExceptionhandler()
           
 java.io.File getFileToSend()
           
 IFileTransferInfo getFileTransferInfo()
           
 IFileTransferListener getFileTransferListener()
           
 java.util.Map getFileTransferOptions()
           
protected abstract  ISendFileTransferContainerAdapter getOutgoingFileTransferAdapter()
          Get the container adapter for actually initiating the file transer request.
 IFileID getTargetReceiver()
           
 void run()
           
protected  void sendFileToTarget()
           
 void setExceptionHandler(IExceptionHandler exceptionHandler)
           
 void setFileToSend(java.io.File fileToSend)
           
 void setFileTransferInfo(IFileTransferInfo info)
           
 void setFileTransferListener(IFileTransferListener listener)
           
 void setFileTransferOptions(java.util.Map options)
           
 void setTargetReceiver(IFileID targetReceiver)
           
 
Methods inherited from class org.eclipse.jface.action.Action
convertAccelerator, convertAccelerator, findKeyCode, findKeyString, findModifier, findModifierString, getAccelerator, getActionDefinitionId, getDescription, getDisabledImageDescriptor, getHelpListener, getHoverImageDescriptor, getId, getImageDescriptor, getMenuCreator, getStyle, getText, getToolTipText, isChecked, isEnabled, isHandled, notifyResult, removeAcceleratorText, removeMnemonics, runWithEvent, setAccelerator, setActionDefinitionId, setChecked, setDescription, setDisabledImageDescriptor, setEnabled, setHelpListener, setHoverImageDescriptor, setId, setImageDescriptor, setMenuCreator, setText, setToolTipText
 
Methods inherited from class org.eclipse.jface.action.AbstractAction
addPropertyChangeListener, firePropertyChange, firePropertyChange, removePropertyChangeListener
 
Methods inherited from class org.eclipse.core.commands.common.EventManager
addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.eclipse.jface.action.IAction
addPropertyChangeListener, removePropertyChangeListener
 

Field Detail

targetReceiver

protected IFileID targetReceiver

fileTransferInfo

protected IFileTransferInfo fileTransferInfo

fileTransferListener

protected IFileTransferListener fileTransferListener

options

protected java.util.Map options

exceptionHandler

protected IExceptionHandler exceptionHandler
Constructor Detail

AbstractFileSendAction

public AbstractFileSendAction()
Method Detail

setTargetReceiver

public void setTargetReceiver(IFileID targetReceiver)

getTargetReceiver

public IFileID getTargetReceiver()

setFileTransferInfo

public void setFileTransferInfo(IFileTransferInfo info)

getFileTransferInfo

public IFileTransferInfo getFileTransferInfo()

setFileToSend

public void setFileToSend(java.io.File fileToSend)

getFileToSend

public java.io.File getFileToSend()

setFileTransferListener

public void setFileTransferListener(IFileTransferListener listener)

getFileTransferListener

public IFileTransferListener getFileTransferListener()

setFileTransferOptions

public void setFileTransferOptions(java.util.Map options)

getFileTransferOptions

public java.util.Map getFileTransferOptions()

setExceptionHandler

public void setExceptionHandler(IExceptionHandler exceptionHandler)

getExceptionhandler

public IExceptionHandler getExceptionhandler()

run

public void run()
Specified by:
run in interface org.eclipse.jface.action.IAction
Overrides:
run in class org.eclipse.jface.action.Action

getOutgoingFileTransferAdapter

protected abstract ISendFileTransferContainerAdapter getOutgoingFileTransferAdapter()
Get the container adapter for actually initiating the file transer request.

Returns:
ISendFileTransferContainerAdapter to use for the action run(). Must not return null.

sendFileToTarget

protected void sendFileToTarget()
                         throws java.lang.Exception
Throws:
java.lang.Exception

createDefaultFileTransferListener

protected IFileTransferListener createDefaultFileTransferListener()
Returns:
IFileTransferListener to use as the default listener. Must not be null.