LEONARDI Application Composer - 8.9.0.40 by W4 S.A.

leon.app.behaviorinterface
Interface LyExportBehaviorInterface

All Superinterfaces:
LyActionBehaviorInterface, LyBehaviorInterface
All Known Implementing Classes:
LyExportBehavior

public interface LyExportBehaviorInterface
extends LyActionBehaviorInterface

This interface defines methods for the behavior of an export action.

See Also:
LyExportController

Field Summary
static java.lang.String __VERSION
          File version
 
Method Summary
 java.util.Vector<java.lang.String> getExportLines(LyExportController controller, java.util.Iterator<LyObject> objects, java.util.Vector<LyFieldInfo> fields, java.lang.String fieldSep, java.lang.String valueSep, java.lang.String exportType)
          Return the lines that will be written in the export file.
 java.lang.String getHeaderMark(LyExportController controller)
          Returns the header mark, as a String, to be used at the beginning of header line.
 boolean isFormDisplayed(LyExportController controller)
          Indicates if the export form is displayed.
 boolean saveFile(LyExportController controller, java.io.File file, java.util.Vector<java.lang.String> lines)
          Saves lines from the given list into the given file.
 
Methods inherited from interface leon.app.behaviorinterface.LyActionBehaviorInterface
endAction, getClientContext, getContextTitle, getHelpFile, getImage, getImageTooltip, getKeyValue, getMenuItemImage, getTitle, reset, startAction
 
Methods inherited from interface leon.app.behaviorinterface.LyBehaviorInterface
free, handleDemand, init
 

Field Detail

__VERSION

static final java.lang.String __VERSION
File version

See Also:
Constant Field Values
Method Detail

getExportLines

java.util.Vector<java.lang.String> getExportLines(LyExportController controller,
                                                  java.util.Iterator<LyObject> objects,
                                                  java.util.Vector<LyFieldInfo> fields,
                                                  java.lang.String fieldSep,
                                                  java.lang.String valueSep,
                                                  java.lang.String exportType)
Return the lines that will be written in the export file.

Parameters:
controller - the current export controller
objects - objects to export.
fields - list of fieldInfos that should be exported to the file.
fieldSep - separator between fields (columns)
valueSep - separator between multiple values
exportType - type of data to export : Possible values are SELECT_EXPORT_TYPE_TEXT (.txt), SELECT_EXPORT_TYPE_RAW (.res) or SELECT_EXPORT_TYPE_SPREADSHEET (.csv).
Returns:
the lines that will be written in the export file, null for standard export.

saveFile

boolean saveFile(LyExportController controller,
                 java.io.File file,
                 java.util.Vector<java.lang.String> lines)
Saves lines from the given list into the given file.

Parameters:
controller - the current export controller
file - the file where data must be saved
lines - the list of lines to save
Returns:
true if file is save, false otherwise

getHeaderMark

java.lang.String getHeaderMark(LyExportController controller)
Returns the header mark, as a String, to be used at the beginning of header line.

Parameters:
controller - the export controller
Returns:
the header mark

isFormDisplayed

boolean isFormDisplayed(LyExportController controller)
Indicates if the export form is displayed.
Export form should not be displayed if all the fields values are given as parameters of the export action.

Parameters:
controller - the export controller
Returns:
true if form is displayed, false otherwise.

(c) January 2013 - W4 S.A.

Website: W4 S.A., contact us: support@w4global.com