Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle ADF Faces
12c (12.1.2)
E23185-01


oracle.adf.view.rich.export
Class ExportContext

java.lang.Object
  extended by oracle.adf.view.rich.export.ExportContext


public class ExportContext
extends Object

The ExportContext holds context information about the current export action.


Constructor Summary
ExportContext()
           

 

Method Summary
 String getCharset()
          Retrieves the charset of the current exporting action.
 String getContentType()
          Retrieves the content type of this export action.
 ExportedRowsType getExportedRowsType()
          Gets the exported row type for the current export action.
 javax.faces.context.FacesContext getFacesContext()
          Retrieves the FacesContext instance associated with the current export action.
 String getFileName()
          Gets the name of the file to export to.
 javax.el.MethodExpression getFilterMethod()
           
 String getFilterName()
          Retrieves the charset of the current exporting action.
 int getRegularColNumber()
          Gets the number of regular columns
 int getRowLimit()
          Retrieves the maximum allowed number of rows to be exported.
 javax.servlet.ServletResponse getServletResponse()
          Gets the ServeletResponse associated with the current export action.
 String getTitle()
          Gets the title of the exported document
 boolean isFirstDetailItem()
          Checks whether the current item being exported is the first component in the detail stamp or not.
 boolean isFirstInRow()
          Checks whether the current cell being exported is the first cell in row or not.
 boolean isSpanned()
          Checks whether the current cell being exported is spanned or not, either by cell before it (colSpan) or above it (rowSpan).
 void setCharset(String charset)
          Sets the charset of the current exporting action.
 void setContentType(String contentType)
          Sets the content type of this export action.
 void setExportedRowsType(ExportedRowsType exportedRowsType)
          Sets the exported row type for the current export action.
 void setFacesContext(javax.faces.context.FacesContext facesContext)
          Sets the FacesContext instance to be associated with the current export action.
 void setFileName(String fileName)
          Sets the name of the file to export to.
 void setFilterMethod(javax.el.MethodExpression filterMethod)
           
 void setFilterName(String filterName)
          Sets the charset of the current exporting action.
 void setFirstDetailItem(boolean firstDetailItem)
          Sets the flag to indicate whether the current item being exported is the first component in the detail stamp or not.
 void setFirstInRow(boolean firstInRow)
          Sets the flag that the current cell being exported is the first cell in row or not.
 void setRegularColNumber(int regularColNumber)
          Sets the number of regular columns
 void setRowLimit(int rowLimit)
          Sets the maximum allowed number of rows to be exported.
 void setServletResponse(javax.servlet.ServletResponse response)
          Sets the ServeletResponse to be associated with the current export action.
 void setSpanned(boolean isSpanned)
          Sets the flag that the current cell being exported is spanned, either by cell before it (colSpan) or above it (rowSpan).
 void setTitle(String title)
          Sets the title of the exported document

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Constructor Detail

ExportContext

public ExportContext()

Method Detail

isSpanned

public boolean isSpanned()
Checks whether the current cell being exported is spanned or not, either by cell before it (colSpan) or above it (rowSpan).

setSpanned

public void setSpanned(boolean isSpanned)
Sets the flag that the current cell being exported is spanned, either by cell before it (colSpan) or above it (rowSpan).

isFirstInRow

public boolean isFirstInRow()
Checks whether the current cell being exported is the first cell in row or not.

setFirstInRow

public void setFirstInRow(boolean firstInRow)
Sets the flag that the current cell being exported is the first cell in row or not.

getCharset

public String getCharset()
Retrieves the charset of the current exporting action.

setCharset

public void setCharset(String charset)
Sets the charset of the current exporting action.

isFirstDetailItem

public boolean isFirstDetailItem()
Checks whether the current item being exported is the first component in the detail stamp or not.

setFirstDetailItem

public void setFirstDetailItem(boolean firstDetailItem)
Sets the flag to indicate whether the current item being exported is the first component in the detail stamp or not.

getExportedRowsType

public ExportedRowsType getExportedRowsType()
Gets the exported row type for the current export action.

setExportedRowsType

public void setExportedRowsType(ExportedRowsType exportedRowsType)
Sets the exported row type for the current export action.

getFileName

public String getFileName()
Gets the name of the file to export to.

setFileName

public void setFileName(String fileName)
Sets the name of the file to export to.

getServletResponse

public javax.servlet.ServletResponse getServletResponse()
Gets the ServeletResponse associated with the current export action.

setServletResponse

public void setServletResponse(javax.servlet.ServletResponse response)
Sets the ServeletResponse to be associated with the current export action.

getTitle

public String getTitle()
Gets the title of the exported document

setTitle

public void setTitle(String title)
Sets the title of the exported document

getRegularColNumber

public int getRegularColNumber()
Gets the number of regular columns

setRegularColNumber

public void setRegularColNumber(int regularColNumber)
Sets the number of regular columns

getFacesContext

public javax.faces.context.FacesContext getFacesContext()
Retrieves the FacesContext instance associated with the current export action.

setFacesContext

public void setFacesContext(javax.faces.context.FacesContext facesContext)
Sets the FacesContext instance to be associated with the current export action.

getContentType

public String getContentType()
Retrieves the content type of this export action.

setContentType

public void setContentType(String contentType)
Sets the content type of this export action.

getRowLimit

public int getRowLimit()
Retrieves the maximum allowed number of rows to be exported. -1 indicating no limit.

setRowLimit

public void setRowLimit(int rowLimit)
Sets the maximum allowed number of rows to be exported. -1 indicating no limit.

getFilterMethod

public javax.el.MethodExpression getFilterMethod()

setFilterMethod

public void setFilterMethod(javax.el.MethodExpression filterMethod)

getFilterName

public String getFilterName()
Retrieves the charset of the current exporting action.

setFilterName

public void setFilterName(String filterName)
Sets the charset of the current exporting action.

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle ADF Faces
12c (12.1.2)
E23185-01


Copyright © 2013 Oracle Corporation. All Rights Reserved.