Style Intelligence v12.0

inetsoft.report.io
Class ExportType

java.lang.Object
  extended by inetsoft.report.io.ExportType

public class ExportType
extends Object

Describes an export type.

Since:
7.0

Constructor Summary
ExportType()
           
 
Method Summary
 void addSupplementalId(int supplementalId)
          Adds a supplemental ID for this export type.
 String getActionClass()
          Gets the class of the ExportAction used to export a report using this export type in the Report Designer.
 String getDescription()
          Gets a description of this export type.
 String getDesignerKey()
          Gets the key used to determine if this export type is included on the "Export" menu of the designer.
 ExportFactory getExportFactory()
          Gets the ExportFactory that creates the Generator or Formatter for this export type.
 String getExtension()
          Gets the file extension for this export type.
 int getFormatId()
          Gets the unique identifier for this export type.
 String getFormatOption()
          Gets the format option string for this export type.
 int getIndex()
          Gets the index of this export type.
 String getMimeType()
          Gets the MIME type for this export type.
 Enumeration getSupplementalIds()
          Gets the supplemental IDs associated with this export type.
 boolean isExportSupported()
          Determines if this export type can be exported from the web.
 boolean isMailSupported()
          Determines if this export type can be sent by email.
 boolean isVisible()
          Determines if this export type is visible.
 void setActionClass(String actionClass)
          Sets the class of the ExportAction used to export a report using this export type in the Report Designer.
 void setDescription(String description)
          Sets the description of this export type.
 void setDesignerKey(String designerKey)
          Sets the key used to determine if this export type is included on the "Export" menu of the designer.
 void setExportFactory(ExportFactory exportFactory)
          Sets the ExportFactory that creates the Generator or Formatter for this export type.
 void setExportSupported(boolean exportSupported)
          Sets whether this export type can be exported from the web.
 void setExtension(String extension)
          Sets the file extension for this export type.
 void setFormatId(int formatId)
          Sets the unique identifier for this export type.
 void setFormatOption(String formatOption)
          Sets the format option string for this export type.
 void setIndex(int index)
          Sets the index of this export type.
 void setMailSupported(boolean mailSupported)
          Sets whether this export type can be sent by email.
 void setMimeType(String mimeType)
          Sets the MIME type for this export type.
 void setVisible(boolean visible)
          Sets whether this export type is visible.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ExportType

public ExportType()
Method Detail

getFormatId

public int getFormatId()
Gets the unique identifier for this export type.

Returns:
the unique identifier.

setFormatId

public void setFormatId(int formatId)
Sets the unique identifier for this export type.

Parameters:
formatId - the unique identifier.

getFormatOption

public String getFormatOption()
Gets the format option string for this export type.

Returns:
the format option string.

setFormatOption

public void setFormatOption(String formatOption)
Sets the format option string for this export type.

Parameters:
formatOption - the format option string.

getExtension

public String getExtension()
Gets the file extension for this export type.

Returns:
the file extension.

setExtension

public void setExtension(String extension)
Sets the file extension for this export type.

Parameters:
extension - the file extension.

getMimeType

public String getMimeType()
Gets the MIME type for this export type.

Returns:
the MIME type.

setMimeType

public void setMimeType(String mimeType)
Sets the MIME type for this export type.

Parameters:
mimeType - the MIME type.

isMailSupported

public boolean isMailSupported()
Determines if this export type can be sent by email.

Returns:
true if this export type can be sent by email; false otherwise.

setMailSupported

public void setMailSupported(boolean mailSupported)
Sets whether this export type can be sent by email.

Parameters:
mailSupported - true if this export type can be sent by email; false otherwise.

isVisible

public boolean isVisible()
Determines if this export type is visible.

Returns:
true if this export type is visible, false otherwise.

setVisible

public void setVisible(boolean visible)
Sets whether this export type is visible.

Parameters:
visible - true if this export type is visible, false otherwise.

isExportSupported

public boolean isExportSupported()
Determines if this export type can be exported from the web.

Returns:
true if this export type can be exported from the web; false otherwise.

setExportSupported

public void setExportSupported(boolean exportSupported)
Sets whether this export type can be exported from the web.

Parameters:
exportSupported - true if this export type can be exported from the web; false otherwise.

getDescription

public String getDescription()
Gets a description of this export type. The description is used in the interfaces for server export, mailing, saving in the archive, and scheduling reports, and on the export menu of the Report Designer.

Returns:
the description.

setDescription

public void setDescription(String description)
Sets the description of this export type. The description is used in the interfaces for server export, mailing, saving in the archive, and scheduling reports, and on the export menu of the Report Designer.

Parameters:
description - the description.

getIndex

public int getIndex()
Gets the index of this export type. The index is used to sort sets of export types.

Returns:
the index of this export type.

setIndex

public void setIndex(int index)
Sets the index of this export type. The index is used to sort sets of export types.

Parameters:
index - the index of this export type.

getDesignerKey

public String getDesignerKey()
Gets the key used to determine if this export type is included on the "Export" menu of the designer.

Returns:
the key for this export type.

setDesignerKey

public void setDesignerKey(String designerKey)
Sets the key used to determine if this export type is included on the "Export" menu of the designer.

Parameters:
designerKey - the key for this export type.

getActionClass

public String getActionClass()
Gets the class of the ExportAction used to export a report using this export type in the Report Designer. If the action class is null this export type will not be available on the export menu.

Returns:
the export action class.

setActionClass

public void setActionClass(String actionClass)
Sets the class of the ExportAction used to export a report using this export type in the Report Designer. If the action class is null this export type will not be available on the export menu.

Parameters:
actionClass - the export action class.

getExportFactory

public ExportFactory getExportFactory()
Gets the ExportFactory that creates the Generator or Formatter for this export type.

Returns:
an ExportFactory object.

setExportFactory

public void setExportFactory(ExportFactory exportFactory)
Sets the ExportFactory that creates the Generator or Formatter for this export type.

Parameters:
exportFactory - an ExportFactory object.

addSupplementalId

public void addSupplementalId(int supplementalId)
Adds a supplemental ID for this export type. Supplemental IDs are typically old or deprecated constants referring to this export type.

Parameters:
supplementalId - the ID to add.

getSupplementalIds

public Enumeration getSupplementalIds()
Gets the supplemental IDs associated with this export type. Supplemental IDs are typically old or deprecated constants referring to this export type.

Returns:
an Enumeration of Integer objects.

Copyright © 1996-2014 InetSoft Technology Corp. All Rights Reserved.