org.xwiki.rendering.macro.office

Class OfficeMacroParameters

java.lang.Object

org.xwiki.rendering.macro.office.OfficeMacroParameters

public class OfficeMacroParameters
extends Object

Parameters for the org.xwiki.rendering.internal.macro.office.OfficeMacro.

Since:

2.5M2

Version:

$Id: d7ed612bff2cfa9c8328890008d7a901a7aa75f4 $

Constructor Summary

Constructors

Constructor and Description
OfficeMacroParameters()

Method Summary

Methods

Modifier and Type	Method and Description
String	getAttachment() Deprecated. since 5.4.6, use #getSource() instead
org.xwiki.rendering.listener.reference.ResourceReference	getReference() IMPORTANT: this method should not be used from Java, its signature is temporary and will change in 6.2.1.
boolean	isFilterStyles()
void	setAttachment(String attachment) Deprecated. since
void	setFilterStyles(boolean filterStyles) Sets whether to filter in-line CSS styles present in the HTML content produced by the OpenOffice server.
void	setReference(org.xwiki.rendering.listener.reference.ResourceReference reference)

Methods inherited from class java.lang.Object

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

Constructor Detail

OfficeMacroParameters

public OfficeMacroParameters()

Method Detail

getAttachment

@Deprecated
public String getAttachment()

Deprecated. since 5.4.6, use #getSource() instead

Returns:

a string reference to the office attachment to be viewed

setAttachment

@Deprecated
public void setAttachment(String attachment)

Deprecated. since

Sets the office attachment to be viewed.

Parameters:

attachment - an attachment string reference

getReference

public org.xwiki.rendering.listener.reference.ResourceReference getReference()

IMPORTANT: this method should not be used from Java, its signature is temporary and will change in 6.2.1.

Returns:

a string reference to the office file to be viewed

Since:

5.4.6, 6.2.2

setReference

public void setReference(org.xwiki.rendering.listener.reference.ResourceReference reference)

Parameters:

reference - the reference to the file to be viewed

Since:

5.4.6, 6.2.2

isFilterStyles

public boolean isFilterStyles()

Returns:

true if the CSS styles present in the HTML content produces by the OpenOffice server are filtered, false otherwise

setFilterStyles

public void setFilterStyles(boolean filterStyles)

Sets whether to filter in-line CSS styles present in the HTML content produced by the OpenOffice server.

Parameters:

filterStyles - true to filter the CSS style present in the HTML content produces by the OpenOffice server, false otherwise