SwfOptions
Inheritance: java.lang.Object, com.aspose.slides.SaveOptions
All Implemented Interfaces: com.aspose.slides.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(); }
Constructors
Constructor | Description |
---|---|
SwfOptions() | Default constructor. |
Methods
Method | Description |
---|---|
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. |
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. |
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. |
SwfOptions()
public SwfOptions()
Default constructor.
getShowHiddenSlides()
public final boolean getShowHiddenSlides()
Specifies whether the generated document should include hidden slides or not. Default is false.
Returns: boolean
setShowHiddenSlides(boolean value)
public final void setShowHiddenSlides(boolean value)
Specifies whether the generated document should include hidden slides or not. Default is false.
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean |
getCompressed()
public final boolean getCompressed()
Specifies whether the generated SWF document should be compressed or not. Default is true.
Returns: boolean
setCompressed(boolean value)
public final 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 final 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 final 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 final boolean getShowPageBorder()
Specifies whether border around pages should be shown. Default is true.
Returns: boolean
setShowPageBorder(boolean value)
public final void setShowPageBorder(boolean value)
Specifies whether border around pages should be shown. Default is true.
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean |
getShowFullScreen()
public final boolean getShowFullScreen()
Show/hide fullscreen button. Can be overridden in flashvars. Default is true.
Returns: boolean
setShowFullScreen(boolean value)
public final void setShowFullScreen(boolean value)
Show/hide fullscreen button. Can be overridden in flashvars. Default is true.
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean |
getShowPageStepper()
public final boolean getShowPageStepper()
Show/hide page stepper. Can be overridden in flashvars. Default is true.
Returns: boolean
setShowPageStepper(boolean value)
public final void setShowPageStepper(boolean value)
Show/hide page stepper. Can be overridden in flashvars. Default is true.
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean |
getShowSearch()
public final boolean getShowSearch()
Show/hide search section. Can be overridden in flashvars. Default is true.
Returns: boolean
setShowSearch(boolean value)
public final void setShowSearch(boolean value)
Show/hide search section. Can be overridden in flashvars. Default is true.
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean |
getShowTopPane()
public final boolean getShowTopPane()
Show/hide whole top pane. Can be overridden in flashvars. Default is true.
Returns: boolean
setShowTopPane(boolean value)
public final 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 final boolean getShowBottomPane()
Show/hide bottom pane. Can be overridden in flashvars. Default is true.
Returns: boolean
setShowBottomPane(boolean value)
public final void setShowBottomPane(boolean value)
Show/hide bottom pane. Can be overridden in flashvars. Default is true.
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean |
getShowLeftPane()
public final boolean getShowLeftPane()
Show/hide left pane. Can be overridden in flashvars. Default is true.
Returns: boolean
setShowLeftPane(boolean value)
public final void setShowLeftPane(boolean value)
Show/hide left pane. Can be overridden in flashvars. Default is true.
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean |
getStartOpenLeftPane()
public final boolean getStartOpenLeftPane()
Start with opened left pane. Can be overridden in flashvars. Default is false.
Returns: boolean
setStartOpenLeftPane(boolean value)
public final 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 final boolean getEnableContextMenu()
Enable/disable context menu. Default is true.
Returns: boolean
setEnableContextMenu(boolean value)
public final void setEnableContextMenu(boolean value)
Enable/disable context menu. Default is true.
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean |
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.
Returns: byte[]
setLogoImageBytes(byte[] value)
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.
Parameters:
Parameter | Type | Description |
---|---|---|
value | byte[] |
getLogoLink()
public final 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 final 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 final int getJpegQuality()
Specifies the quality of JPEG images. Default is 95.
Returns: int
setJpegQuality(int value)
public final void setJpegQuality(int value)
Specifies the quality of JPEG images. Default is 95.
Parameters:
Parameter | Type | Description |
---|---|---|
value | int |
getNotesCommentsLayouting()
public final INotesCommentsLayoutingOptions getNotesCommentsLayouting()
Provides options that control how notes and comments is placed in exported document.
Returns: INotesCommentsLayoutingOptions