org.xwiki.rendering.macro.include
Class IncludeMacroParameters

java.lang.Object
  org.xwiki.rendering.macro.include.IncludeMacroParameters

public class IncludeMacroParameters
extends Object

Parameters for the org.xwiki.rendering.internal.macro.include.IncludeMacro Macro.

Since:

1.6M1

Version:

$Id: 3cce3cde5054a9b506f11ed69d92147b1a0384ed $

Nested Class Summary

static class

IncludeMacroParameters.Context

Constructor Summary

IncludeMacroParameters()

Method Summary

IncludeMacroParameters.Context	getContext()
String	getDocument() Deprecated. since 3.4M1 use getReference() instead
String	getReference()
String	getSection()
EntityType	getType()
void	setContext(IncludeMacroParameters.Context context)
void	setDocument(String document) Deprecated. since 3.4M1 use setReference(String) instead
void	setReference(String reference) Note: should be mandatory but would break retro compatibility for older macro using setDocument(String).
void	setSection(String sectionId)
void	setType(EntityType type)

Methods inherited from class java.lang.Object

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

Constructor Detail

IncludeMacroParameters

public IncludeMacroParameters()

Method Detail

setReference

public void setReference(String reference)

Note: should be mandatory but would break retro compatibility for older macro using setDocument(String).

Parameters:

reference - the reference to display

Since:

3.4M1

getReference

public String getReference()

Returns:

the reference of the resource to display

Since:

3.4M1

getType

public EntityType getType()

Returns:

the type of the reference

Since:

3.4M1

setType

public void setType(EntityType type)

Parameters:

type - the type of the reference

Since:

3.4M1

setDocument

@Deprecated
public void setDocument(String document)

Deprecated. since 3.4M1 use setReference(String) instead

Parameters:

document - the name of the document to include.

getDocument

@Deprecated
public String getDocument()

Deprecated. since 3.4M1 use getReference() instead

Returns:

the name of the document to include.

setContext

public void setContext(IncludeMacroParameters.Context context)

Parameters:

context - defines whether the included page is executed in its separated execution context or whether it's executed in the context of the current page.

getContext

public IncludeMacroParameters.Context getContext()

Returns:

defines whether the included page is executed in its separated execution context or whether it's executed in the context of the current page.

setSection

public void setSection(String sectionId)

Parameters:

sectionId - see getSection()

getSection

public String getSection()

Returns:

the optional id of a section to include in the referenced document. If not specified the whole document is included.