ISwfOptions

All Implemented Interfaces: com.aspose.slides.ISaveOptions

public interface ISwfOptions extends ISaveOptions

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

Methods

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

getCompressed()

public abstract boolean getCompressed()

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

Returns: boolean

setCompressed(boolean value)

public abstract void setCompressed(boolean value)

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

Parameters:

Parameter	Type	Description
value	boolean

getViewerIncluded()

public abstract boolean getViewerIncluded()

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

Returns: boolean

setViewerIncluded(boolean value)

public abstract void setViewerIncluded(boolean value)

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

Parameters:

Parameter	Type	Description
value	boolean

getShowPageBorder()

public abstract boolean getShowPageBorder()

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

Returns: boolean

setShowPageBorder(boolean value)

public abstract void setShowPageBorder(boolean value)

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

Parameters:

Parameter	Type	Description
value	boolean

getShowHiddenSlides()

public abstract boolean getShowHiddenSlides()

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

Returns: boolean

setShowHiddenSlides(boolean value)

public abstract void setShowHiddenSlides(boolean value)

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

Parameters:

Parameter	Type	Description
value	boolean

getShowFullScreen()

public abstract boolean getShowFullScreen()

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

Returns: boolean

setShowFullScreen(boolean value)

public abstract void setShowFullScreen(boolean value)

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

Parameters:

Parameter	Type	Description
value	boolean

getShowPageStepper()

public abstract boolean getShowPageStepper()

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

Returns: boolean

setShowPageStepper(boolean value)

public abstract void setShowPageStepper(boolean value)

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

Parameters:

Parameter	Type	Description
value	boolean

getShowSearch()

public abstract boolean getShowSearch()

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

Returns: boolean

setShowSearch(boolean value)

public abstract void setShowSearch(boolean value)

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

Parameters:

Parameter	Type	Description
value	boolean

getShowTopPane()

public abstract boolean getShowTopPane()

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

Returns: boolean

setShowTopPane(boolean value)

public abstract void setShowTopPane(boolean value)

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

Parameters:

Parameter	Type	Description
value	boolean

getShowBottomPane()

public abstract boolean getShowBottomPane()

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

Returns: boolean

setShowBottomPane(boolean value)

public abstract void setShowBottomPane(boolean value)

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

Parameters:

Parameter	Type	Description
value	boolean

getShowLeftPane()

public abstract boolean getShowLeftPane()

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

Returns: boolean

setShowLeftPane(boolean value)

public abstract void setShowLeftPane(boolean value)

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

Parameters:

Parameter	Type	Description
value	boolean

getStartOpenLeftPane()

public abstract boolean getStartOpenLeftPane()

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

Returns: boolean

setStartOpenLeftPane(boolean value)

public abstract void setStartOpenLeftPane(boolean value)

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

Parameters:

Parameter	Type	Description
value	boolean

getEnableContextMenu()

public abstract boolean getEnableContextMenu()

Enable/disable context menu. Default is true.

Returns: boolean

setEnableContextMenu(boolean value)

public abstract void setEnableContextMenu(boolean value)

Enable/disable context menu. Default is true.

Parameters:

Parameter	Type	Description
value	boolean

getLogoImageBytes()

public abstract 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.

Returns: byte[]

setLogoImageBytes(byte[] value)

public abstract 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.

Parameters:

Parameter	Type	Description
value	byte[]

getLogoLink()

public abstract String getLogoLink()

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

Returns: java.lang.String

setLogoLink(String value)

public abstract void setLogoLink(String value)

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

Parameters:

Parameter	Type	Description
value	java.lang.String

getJpegQuality()

public abstract int getJpegQuality()

Specifies the quality of JPEG images. Default is 95.

Returns: int

setJpegQuality(int value)

public abstract void setJpegQuality(int value)

Specifies the quality of JPEG images. Default is 95.

Parameters:

Parameter	Type	Description
value	int

getNotesCommentsLayouting()

public abstract INotesCommentsLayoutingOptions getNotesCommentsLayouting()

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

Returns: INotesCommentsLayoutingOptions

getSlidesLayoutOptions()

public abstract 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();
 }

Returns: ISlidesLayoutOptions

setSlidesLayoutOptions(ISlidesLayoutOptions value)

public abstract 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();
 }

Parameters:

Parameter	Type	Description
value	ISlidesLayoutOptions