Package com.xwiki.macros.excerptinclude.macro

Class ExcerptIncludeMacroParameters

java.lang.Object

com.xwiki.macros.excerptinclude.macro.ExcerptIncludeMacroParameters

@Unstable
public class ExcerptIncludeMacroParameters
extends Object

Defines parameters for the ExcerptIncludeMacro Macro.

Since:

1.14.5

Version:

$Id$

Constructor Summary

Constructors

Constructor	Description
ExcerptIncludeMacroParameters()

Method Summary

Modifier and Type	Method	Description
String	getName()
org.xwiki.model.reference.DocumentReference	getReference()	Retrieves the reference to the document from which the excerpt is to be included.
boolean	isInline()
boolean	isNopanel()
void	setInline(boolean inline)	Explicitly sets inline mode.
void	setName(String name)	Sets the name of the excerpt to be included.
void	setNopanel(boolean nopanel)	Sets the name of the excerpt to be included.
void	setReference(org.xwiki.model.reference.DocumentReference reference)	Sets the reference to the document from which the excerpt is to be included.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExcerptIncludeMacroParameters

public ExcerptIncludeMacroParameters()

Method Detail

getReference

public org.xwiki.model.reference.DocumentReference getReference()

Retrieves the reference to the document from which the excerpt is to be included.

Returns:

A DocumentReference object representing the document reference.

Since:

1.14.5

setReference

public void setReference(org.xwiki.model.reference.DocumentReference reference)

Sets the reference to the document from which the excerpt is to be included.

Parameters:

reference - A DocumentReference object representing the document reference.

getName

public String getName()

Returns:

the name of the excerpt to be included.

Since:

1.18.0

setName

public void setName(String name)

Sets the name of the excerpt to be included.

Parameters:

name - the name to set.

Since:

1.18.0

isNopanel

public boolean isNopanel()

Returns:

the name of the excerpt to be included.

Since:

1.19.0

setNopanel

public void setNopanel(boolean nopanel)

Sets the name of the excerpt to be included.

Parameters:

nopanel - the name to set.

Since:

1.19.0

isInline

public boolean isInline()

Returns:

whether the macro is explicitly in inline mode.

Since:

1.25.1

setInline

public void setInline(boolean inline)

Explicitly sets inline mode. Note that if the macro is used inline, it will be inline.

Parameters:

inline - the name to set.

Since:

1.25.1