com.aspose.slides

Class SwfOptions

java.lang.Object

com.aspose.slides.SaveOptions

com.aspose.slides.SwfOptions

All Implemented Interfaces:

ISaveOptions, ISwfOptions

public class SwfOptions
extends SaveOptions
implements ISwfOptions

Provides options that control how a presentation is saved in Swf format.

 The following example shows how to convert PowerPoint to SWF Flash.
 
 // Instantiate a Presentation object that represents a presentation file
 Presentation pres = new Presentation("HelloWorld.pptx");
 try {
     SwfOptions swfOptions = new SwfOptions();
     swfOptions.setViewerIncluded(false);
     INotesCommentsLayoutingOptions notesOptions = swfOptions.getNotesCommentsLayouting();
     notesOptions.setNotesPosition(NotesPositions.BottomFull);
     // Saving presentation and notes pages
     pres.save("SaveAsSwf_out.swf", SaveFormat.Swf, swfOptions);
     swfOptions.setViewerIncluded(true);
     pres.save("SaveNotes_out.swf", SaveFormat.Swf, swfOptions);
 } finally {
     if (pres != null) pres.dispose();
 }
 
 

Constructor Summary

Constructors

Constructor and Description
SwfOptions() Default constructor.

Method Summary

Modifier and Type	Method and Description
boolean	getCompressed() Specifies whether the generated SWF document should be compressed or not.
boolean	getEnableContextMenu() Enable/disable context menu.
int	getJpegQuality() Specifies the quality of JPEG images.
byte[]	getLogoImageBytes() Image that will be displayed as logo in the top right corner of the viewer.
java.lang.String	getLogoLink() Gets or sets the full hyperlink address for a logo.
INotesCommentsLayoutingOptions	getNotesCommentsLayouting() Deprecated. Use SlidesLayoutOptions property. The property NotesCommentsLayouting will be removed after release of version 25.8.
boolean	getShowBottomPane() Show/hide bottom pane.
boolean	getShowFullScreen() Show/hide fullscreen button.
boolean	getShowHiddenSlides() Specifies whether the generated document should include hidden slides or not.
boolean	getShowLeftPane() Show/hide left pane.
boolean	getShowPageBorder() Specifies whether border around pages should be shown.
boolean	getShowPageStepper() Show/hide page stepper.
boolean	getShowSearch() Show/hide search section.
boolean	getShowTopPane() Show/hide whole top pane.
ISlidesLayoutOptions	getSlidesLayoutOptions() Gets or sets the mode in which slides are placed on the page when exporting a presentation ISlidesLayoutOptions.
boolean	getStartOpenLeftPane() Start with opened left pane.
boolean	getViewerIncluded() Specifies whether the generated SWF document should include the integrated document viewer or not.
void	setCompressed(boolean value) Specifies whether the generated SWF document should be compressed or not.
void	setEnableContextMenu(boolean value) Enable/disable context menu.
void	setJpegQuality(int value) Specifies the quality of JPEG images.
void	setLogoImageBytes(byte[] value) Image that will be displayed as logo in the top right corner of the viewer.
void	setLogoLink(java.lang.String value) Gets or sets the full hyperlink address for a logo.
void	setShowBottomPane(boolean value) Show/hide bottom pane.
void	setShowFullScreen(boolean value) Show/hide fullscreen button.
void	setShowHiddenSlides(boolean value) Specifies whether the generated document should include hidden slides or not.
void	setShowLeftPane(boolean value) Show/hide left pane.
void	setShowPageBorder(boolean value) Specifies whether border around pages should be shown.
void	setShowPageStepper(boolean value) Show/hide page stepper.
void	setShowSearch(boolean value) Show/hide search section.
void	setShowTopPane(boolean value) Show/hide whole top pane.
void	setSlidesLayoutOptions(ISlidesLayoutOptions value) Gets or sets the mode in which slides are placed on the page when exporting a presentation ISlidesLayoutOptions.
void	setStartOpenLeftPane(boolean value) Start with opened left pane.
void	setViewerIncluded(boolean value) Specifies whether the generated SWF document should include the integrated document viewer or not.

Methods inherited from class com.aspose.slides.SaveOptions

getDefaultRegularFont, getGradientStyle, getProgressCallback, getSkipJavaScriptLinks, getWarningCallback, setDefaultRegularFont, setGradientStyle, setProgressCallback, setSkipJavaScriptLinks, setWarningCallback

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.aspose.slides.ISaveOptions

getDefaultRegularFont, getGradientStyle, getProgressCallback, getSkipJavaScriptLinks, getWarningCallback, setDefaultRegularFont, setGradientStyle, setProgressCallback, setSkipJavaScriptLinks, setWarningCallback

Constructor Detail

SwfOptions

public SwfOptions()

Default constructor.

Method Detail

getShowHiddenSlides

public final boolean getShowHiddenSlides()

Specifies whether the generated document should include hidden slides or not. Default is false.

Specified by:

getShowHiddenSlides in interface ISwfOptions

setShowHiddenSlides

public final void setShowHiddenSlides(boolean value)

Specifies whether the generated document should include hidden slides or not. Default is false.

Specified by:

setShowHiddenSlides in interface ISwfOptions

getCompressed

public final boolean getCompressed()

Specifies whether the generated SWF document should be compressed or not. Default is true.

Specified by:

getCompressed in interface ISwfOptions

setCompressed

public final void setCompressed(boolean value)

Specifies whether the generated SWF document should be compressed or not. Default is true.

Specified by:

setCompressed in interface ISwfOptions

getViewerIncluded

public final boolean getViewerIncluded()

Specifies whether the generated SWF document should include the integrated document viewer or not. Default is true.

Specified by:

getViewerIncluded in interface ISwfOptions

setViewerIncluded

public final void setViewerIncluded(boolean value)

Specifies whether the generated SWF document should include the integrated document viewer or not. Default is true.

Specified by:

setViewerIncluded in interface ISwfOptions

getShowPageBorder

public final boolean getShowPageBorder()

Specifies whether border around pages should be shown. Default is true.

Specified by:

getShowPageBorder in interface ISwfOptions

setShowPageBorder

public final void setShowPageBorder(boolean value)

Specifies whether border around pages should be shown. Default is true.

Specified by:

setShowPageBorder in interface ISwfOptions

getShowFullScreen

public final boolean getShowFullScreen()

Show/hide fullscreen button. Can be overridden in flashvars. Default is true.

Specified by:

getShowFullScreen in interface ISwfOptions

setShowFullScreen

public final void setShowFullScreen(boolean value)

Show/hide fullscreen button. Can be overridden in flashvars. Default is true.

Specified by:

setShowFullScreen in interface ISwfOptions

getShowPageStepper

public final boolean getShowPageStepper()

Show/hide page stepper. Can be overridden in flashvars. Default is true.

Specified by:

getShowPageStepper in interface ISwfOptions

setShowPageStepper

public final void setShowPageStepper(boolean value)

Show/hide page stepper. Can be overridden in flashvars. Default is true.

Specified by:

setShowPageStepper in interface ISwfOptions

getShowSearch

public final boolean getShowSearch()

Show/hide search section. Can be overridden in flashvars. Default is true.

Specified by:

getShowSearch in interface ISwfOptions

setShowSearch

public final void setShowSearch(boolean value)

Show/hide search section. Can be overridden in flashvars. Default is true.

Specified by:

setShowSearch in interface ISwfOptions

getShowTopPane

public final boolean getShowTopPane()

Show/hide whole top pane. Can be overridden in flashvars. Default is true.

Specified by:

getShowTopPane in interface ISwfOptions

setShowTopPane

public final void setShowTopPane(boolean value)

Show/hide whole top pane. Can be overridden in flashvars. Default is true.

Specified by:

setShowTopPane in interface ISwfOptions

getShowBottomPane

public final boolean getShowBottomPane()

Show/hide bottom pane. Can be overridden in flashvars. Default is true.

Specified by:

getShowBottomPane in interface ISwfOptions

setShowBottomPane

public final void setShowBottomPane(boolean value)

Show/hide bottom pane. Can be overridden in flashvars. Default is true.

Specified by:

setShowBottomPane in interface ISwfOptions

getShowLeftPane

public final boolean getShowLeftPane()

Show/hide left pane. Can be overridden in flashvars. Default is true.

Specified by:

getShowLeftPane in interface ISwfOptions

setShowLeftPane

public final void setShowLeftPane(boolean value)

Show/hide left pane. Can be overridden in flashvars. Default is true.

Specified by:

setShowLeftPane in interface ISwfOptions

getStartOpenLeftPane

public final boolean getStartOpenLeftPane()

Start with opened left pane. Can be overridden in flashvars. Default is false.

Specified by:

getStartOpenLeftPane in interface ISwfOptions

setStartOpenLeftPane

public final void setStartOpenLeftPane(boolean value)

Start with opened left pane. Can be overridden in flashvars. Default is false.

Specified by:

setStartOpenLeftPane in interface ISwfOptions

getEnableContextMenu

public final boolean getEnableContextMenu()

Enable/disable context menu. Default is true.

Specified by:

getEnableContextMenu in interface ISwfOptions

setEnableContextMenu

public final void setEnableContextMenu(boolean value)

Enable/disable context menu. Default is true.

Specified by:

setEnableContextMenu in interface ISwfOptions

getLogoImageBytes

public final byte[] getLogoImageBytes()

Image that will be displayed as logo in the top right corner of the viewer. Image should be 32x64 pixels PNG image, otherwise logo can be displayed improperly.

Specified by:

getLogoImageBytes in interface ISwfOptions

setLogoImageBytes

public final void setLogoImageBytes(byte[] value)

Image that will be displayed as logo in the top right corner of the viewer. Image should be 32x64 pixels PNG image, otherwise logo can be displayed improperly.

Specified by:

setLogoImageBytes in interface ISwfOptions

getLogoLink

public final java.lang.String getLogoLink()

Gets or sets the full hyperlink address for a logo. Has an effect only if a (getLogoImageBytes()/setLogoImageBytes(byte[])) is specified.

Specified by:

getLogoLink in interface ISwfOptions

setLogoLink

public final void setLogoLink(java.lang.String value)

Gets or sets the full hyperlink address for a logo. Has an effect only if a (getLogoImageBytes()/setLogoImageBytes(byte[])) is specified.

Specified by:

setLogoLink in interface ISwfOptions

getJpegQuality

public final int getJpegQuality()

Specifies the quality of JPEG images. Default is 95.

Specified by:

getJpegQuality in interface ISwfOptions

setJpegQuality

public final void setJpegQuality(int value)

Specifies the quality of JPEG images. Default is 95.

Specified by:

setJpegQuality in interface ISwfOptions

getNotesCommentsLayouting

@Deprecated
public final INotesCommentsLayoutingOptions getNotesCommentsLayouting()

Deprecated. Use SlidesLayoutOptions property. The property NotesCommentsLayouting will be removed after release of version 25.8.

Provides options that control how notes and comments is placed in exported document.

Specified by:

getNotesCommentsLayouting in interface ISwfOptions

getSlidesLayoutOptions

public final ISlidesLayoutOptions getSlidesLayoutOptions()

Gets or sets the mode in which slides are placed on the page when exporting a presentation ISlidesLayoutOptions. This property doesn't support assigning objects of type HandoutLayoutingOptions

Example:
 
 Presentation pres = new Presentation("pres.pptx");
 try {
     NotesCommentsLayoutingOptions notesOptions = new NotesCommentsLayoutingOptions();
     notesOptions.setCommentsPosition(CommentsPositions.Right);

     SwfOptions options = new SwfOptions();
     options.setSlidesLayoutOptions(notesOptions);

     pres.save("pres.swf", SaveFormat.Swf, options);
 } finally {
     if (pres != null) pres.dispose();
 }
 
 

Specified by:

getSlidesLayoutOptions in interface ISwfOptions

setSlidesLayoutOptions

public final void setSlidesLayoutOptions(ISlidesLayoutOptions value)

Gets or sets the mode in which slides are placed on the page when exporting a presentation ISlidesLayoutOptions. This property doesn't support assigning objects of type HandoutLayoutingOptions.

Example:
 
 Presentation pres = new Presentation("pres.pptx");
 try {
     NotesCommentsLayoutingOptions notesOptions = new NotesCommentsLayoutingOptions();
     notesOptions.setCommentsPosition(CommentsPositions.Right);

     SwfOptions options = new SwfOptions();
     options.setSlidesLayoutOptions(notesOptions);

     pres.save("pres.swf", SaveFormat.Swf, options);
 } finally {
     if (pres != null) pres.dispose();
 }
 
 

Specified by:

setSlidesLayoutOptions in interface ISwfOptions