es.unex.sextante.additionalInfo
Class AdditionalInfoFilepath

java.lang.Object
  extended by es.unex.sextante.additionalInfo.AdditionalInfoFilepath
All Implemented Interfaces:
AdditionalInfo

public class AdditionalInfoFilepath
extends java.lang.Object
implements AdditionalInfo

Additional info for a parameter representing a filepath

Author:
Victor Olaya volaya@unex.es

Constructor Summary
AdditionalInfoFilepath()
           
AdditionalInfoFilepath(boolean bFolder, boolean bOpenDialog, java.lang.String sExtension)
           
 
Method Summary
 java.lang.String getExtension()
          Returns the extension that the file must have
 java.lang.String getTextDescription()
           
 boolean isFolder()
          Return true if the parameter contains a folder and not a file path
 boolean isOpenDialog()
          Returns whether a open file dialog or a save file dialog should be used to set the value of this parameter
 void setExtension(java.lang.String sExt)
          Sets a new mandatory extension for the filename
 void setIsFolder(boolean folder)
          Sets whether the parameter contains a folder and not a file path
 void setIsOpenDialog(boolean openDialog)
          Sets whether a open file dialog or a save file dialog should be used to set the value of this parameter
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AdditionalInfoFilepath

public AdditionalInfoFilepath()

AdditionalInfoFilepath

public AdditionalInfoFilepath(boolean bFolder,
                              boolean bOpenDialog,
                              java.lang.String sExtension)
Parameters:
bFolder - true if the parameter contains a folder and not a file path
bOpenDialog - true if it is a file to be opened. False if it is a filename to be used to save something. This will define the type of file chooser dialog to show.
sExtension - the extension that the file must have
Method Detail

getExtension

public java.lang.String getExtension()
Returns the extension that the file must have

Returns:
the file extension

setExtension

public void setExtension(java.lang.String sExt)
Sets a new mandatory extension for the filename

Parameters:
sExt - the new extension

isFolder

public boolean isFolder()
Return true if the parameter contains a folder and not a file path

Returns:
whether the paramete contais a folder and not a file path

setIsFolder

public void setIsFolder(boolean folder)
Sets whether the parameter contains a folder and not a file path

Parameters:
folder -

isOpenDialog

public boolean isOpenDialog()
Returns whether a open file dialog or a save file dialog should be used to set the value of this parameter

Returns:
whether a open file dialog or a save file dialog should be used to set the value of this parameter

setIsOpenDialog

public void setIsOpenDialog(boolean openDialog)
Sets whether a open file dialog or a save file dialog should be used to set the value of this parameter

Parameters:
openDialog - true if a open file dialog should be used

getTextDescription

public java.lang.String getTextDescription()
Specified by:
getTextDescription in interface AdditionalInfo