class: ExportItems

public class: ExportItems
Author: : Galina Stancheva, created 02.08.2007
Project: Phase: 1.0; Status: Proposed; Version: : $Revision: 2617 $ $LastChangedDate: 2009-05-08 1; Complexity: 1
Dates: Created: 16.07.2009 15:32:28; Modified: 16.07.2009 15:32:28;
Flags: Active: false; IsRoot: false; IsLeaf: false;
Extension Points:
UUID: {6FE05E1D-F8CA-4ca3-9B8A-3BCB153BFB60}
Fragment class for item exporting. This class provides all functionality for exporting items according the selected export format (layout or structured) and the selected file format (PDF, TXT, etc..).
 

Goto: Custom Properties, Fields, Methods

Extends: FacesBean

See also: FacesBean

Appears in: export

Connections
 
Custom Properties
 
ExportItems Attributes
Attribute Details
public static const String
  BEAN_NAME
Initial: "ExportItems"
public SelectItem
  EXPORTFORMAT_AJP
Initial: new SelectItem("AJP", getLabel("Export_ExportFormat_AJP"))
public SelectItem
  EXPORTFORMAT_APA
Initial: new SelectItem("APA", getLabel("Export_ExportFormat_APA"))
public SelectItem
  EXPORTFORMAT_BIBTEX
Initial: new SelectItem("BIBTEX", getLabel("Export_ExportFormat_BIBTEX"))
public SelectItem
  EXPORTFORMAT_ENDNOTE
Initial: new SelectItem("ENDNOTE", getLabel("Export_ExportFormat_ENDNOTE"))
Notes: constants for comboBoxes and HtmlSelectOneRadios
public SelectItem
  EXPORTFORMAT_OPTIONS
Initial: new SelectItem[]{EXPORTFORMAT_ENDNOTE, EXPORTFORMAT_BIBTEX, EXPORTFORMAT_XML, EXPORTFORMAT_APA, EXPORTFORMAT_AJP}
Notes: public SelectItemGroup CITATIONSTYLES_GROUP = new SelectItemGroup(getLabel("Export_CitationStyles_Group"), "", false, new SelectItem[]{EXPORTFORMAT_APA, EXPORTFORMAT_AJP}); public SelectItem[] EXPORTFORMAT_OPTIONS = new SelectItem[]{EXPORTFORMAT_ENDNOTE, EXPORTFORMAT_BIBTEX, EXPORTFORMAT_XML, CITATIONSTYLES_GROUP};
public SelectItem
  EXPORTFORMAT_XML
Initial: new SelectItem("XML", getLabel("Export_ExportFormat_XML"))
public SelectItem
  FILEFORMAT_HTML
Initial: new SelectItem("html", getLabel("Export_FileFormat_HTML"))
public SelectItem
  FILEFORMAT_ODT
Initial: new SelectItem("odt", getLabel("Export_FileFormat_ODT"))
public SelectItem
  FILEFORMAT_OPTIONS
Initial: new SelectItem[]{FILEFORMAT_PDF, FILEFORMAT_ODT, FILEFORMAT_RTF, FILEFORMAT_HTML, FILEFORMAT_SNIPPET}
public SelectItem
  FILEFORMAT_PDF
Initial: new SelectItem("pdf", getLabel("Export_FileFormat_PDF"))
public SelectItem
  FILEFORMAT_RTF
Initial: new SelectItem("rtf", getLabel("Export_FileFormat_RTF"))
public SelectItem
  FILEFORMAT_SNIPPET
Initial: new SelectItem("snippet", getLabel("Export_FileFormat_SNIPPET"))
private const String
  FUNCTION_EXPORT
Initial: "export"
Notes: constant for the function export to check the rights and/or if the function has to be disabled (DiT)
private static Logger
  logger
Initial: Logger.getLogger(ExportItems.class)
public static const String
  MESSAGE_EXPORT_EMAIL_NOTSENT
Initial: "exportItems_EmailNotSent"
public static const String
  MESSAGE_EXPORT_EMAIL_RECIPIENTS_ARE_NOT_DEFINED
Initial: "exportItems_RecipientsAreNotDefined"
public static const String
  MESSAGE_EXPORT_EMAIL_SENT
Initial: "exportItems_EmailSent"
public static const String
  MESSAGE_EXPORT_EMAIL_SUBJECT_TEXT
Initial: "exportItems_EmailSubjectText"
public static const String
  MESSAGE_EXPORT_EMAIL_TEXT
Initial: "exportItems_EmailText"
public static const String
  MESSAGE_EXPORT_EMAIL_UNKNOWN_RECIPIENTS
Initial: "exportItems_UnknownRecipients"
public static const String
  MESSAGE_NO_EXPORTDATA_DELIVERED
Initial: "exportItems_NoDataDelivered"
Notes: constants for error and status messages
public static const String
  MESSAGE_NO_ITEM_FOREXPORT_SELECTED
Initial: "exportItems_NoItemSelected"
Notes: constants for error and status messages
private HtmlMessages
  valMessage
Initial: new HtmlMessages()
Notes: binded components in JSP
 
ExportItems Methods
Operation Details
public
backToList():String
Sequential
Notes: redirects the user to the list he came from
@return String nav rule for loading the page the user came from
private
cleanUpEmailFields():void
Sequential
Notes: Clean up some fields on the Email interface
public
disableExportPanComps(
   boolean b):void
Sequential
Notes: Disables the export components when the email page gets open.
public
ExportItems():
Sequential
Notes: Default constructor.
public
getEXPORTFORMAT_OPTIONS():SelectItem
Sequential <<property get>>
Tags: attribute_name=EXPORTFORMAT_OPTIONS
public
getFILEFORMAT_OPTIONS():SelectItem
Sequential <<property get>>
Tags: attribute_name=FILEFORMAT_OPTIONS
protected
getItemControllerSessionBean():ItemControllerSessionBean
Sequential
Notes: Returns a reference to the scoped data bean (the ItemControllerSessionBean).
@return a reference to the scoped data bean
protected
getRightsManagementSessionBean():RightsManagementSessionBean
Sequential
Notes: Returns the RightsManagementSessionBean.
@author StG
@return a reference to the scoped data bean (RightsManagementSessionBean)
public
getSessionBean():ExportItemsSessionBean
Sequential
Notes: Gets the session bean.
public
getValMessage():HtmlMessages
Sequential
public
getVisibleExport():boolean
Sequential
Notes: Returns true if the AdvancedSearch should be disabled by the escidoc properties file.
@author StG
@return
public
init():void
Sequential
Notes: Callback method that is called whenever a page containing this page fragment is navigated to, either directly via a URL, or indirectly via page navigation.
public
sendEMail():String
Sequential
Notes: redirects the user to the list he came from
@return String nav rule for loading the page the user came from
public
setExportFormats():String
Sequential
public
setValMessage(
   HtmlMessages valMessage):void
Sequential
public
updateExportFormats():void
Sequential
Notes: Updates the GUI relatively the selected export format.