|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IFileExportBean
Action Handlers that wish to export a file to the user can pass an
instance of this interface to the BaseViewBean.streamFileDataToResponse(IFileExportBean)
API.
Field Summary | |
---|---|
static int |
UNKNOWN_CONTENT_LENGTH
Use this constant for the export content length when the length is not known |
Method Summary | |
---|---|
int |
getExportContentLength()
Return the length of the content that is to be exported. |
String |
getExportContentType()
Gets the content type of the response being sent to the client. |
String |
getExportFileName()
Return the file name for the exported data |
boolean |
isDownloadForced()
Return true to send the response headers that will force the user to choose what to do with the file (Open vs. |
boolean |
isExportBinary()
Return true if the export will be sending binary data to the response, false if the export will be sending text. |
void |
writeExportBytes(OutputStream outStream)
Invoked to allow the bean to write binary data to the output stream. |
void |
writeExportText(PrintWriter writer)
Invoked to allow the bean to write the export text to the output writer. |
Field Detail |
---|
static final int UNKNOWN_CONTENT_LENGTH
Method Detail |
---|
boolean isDownloadForced()
String getExportFileName()
String getExportContentType()
int getExportContentLength()
IFileExportBean.UNKNOWN_CONTENT_LENGTH
if it is not knownboolean isExportBinary()
void writeExportText(PrintWriter writer)
writer
- the output writervoid writeExportBytes(OutputStream outStream) throws IOException
outStream
- the output stream
IOException
- thrown if there is an I/O exception during the export
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |