|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.xwiki.component.wiki.internal.DefaultWikiComponent
public class DefaultWikiComponent
Default implementation of a wiki component definition.
Constructor Summary | |
---|---|
DefaultWikiComponent(DocumentReference documentReference,
DocumentReference authorReference,
Type roleType,
String roleHint,
WikiComponentScope scope)
Constructor of this component. |
Method Summary | |
---|---|
DocumentReference |
getAuthorReference()
Get the reference to the author of the document this component instance is bound to. |
Map<String,ComponentDescriptor> |
getDependencies()
Methods returned by getHandledMethods() can require other components to be injected in their context. |
DocumentReference |
getDocumentReference()
Get the reference of the document this component instance is bound to. |
Map<String,XDOM> |
getHandledMethods()
Get the implementations of all the methods the component handles. |
List<Class<?>> |
getImplementedInterfaces()
Get the list of interfaces the wiki component implements, apart from its main Role. |
String |
getRoleHint()
|
Type |
getRoleType()
|
WikiComponentScope |
getScope()
|
Syntax |
getSyntax()
|
void |
setDependencies(Map<String,ComponentDescriptor> dependencies)
Sets the component dependencies. |
void |
setHandledMethods(Map<String,XDOM> methods)
Sets the handled method. |
void |
setImplementedInterfaces(List<Class<?>> interfaces)
Sets the implemented interfaces. |
void |
setSyntax(Syntax syntax)
Set the syntax in which the component document is written. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DefaultWikiComponent(DocumentReference documentReference, DocumentReference authorReference, Type roleType, String roleHint, WikiComponentScope scope)
documentReference
- the document holding the component definitionauthorReference
- the author of the document holding the component definitionroleType
- the role Type implementedroleHint
- the role hint for this role implementationscope
- the scope of this componentMethod Detail |
---|
public DocumentReference getDocumentReference()
WikiComponent
getDocumentReference
in interface WikiComponent
public DocumentReference getAuthorReference()
WikiComponent
getAuthorReference
in interface WikiComponent
public Map<String,XDOM> getHandledMethods()
XDOM
will be executed.
public Type getRoleType()
getRoleType
in interface WikiComponent
public String getRoleHint()
getRoleHint
in interface WikiComponent
public WikiComponentScope getScope()
getScope
in interface WikiComponent
WikiComponentScope
of the component.public List<Class<?>> getImplementedInterfaces()
WikiComponentManager
to add those
Interfaces to the list of implemented interfaces of the Proxy
it will create.
public Map<String,ComponentDescriptor> getDependencies()
getHandledMethods()
can require other components to be injected in their context.
Each entry in the map returned by this method will be injected in the rendering context when methods will be
executed. The name of the variable in the context is defined by the key in the returned Map.
public Syntax getSyntax()
public void setHandledMethods(Map<String,XDOM> methods)
methods
- the methods this component will handle#getHandledMethods()}
public void setImplementedInterfaces(List<Class<?>> interfaces)
interfaces
- the interfaces this component implements#getImplementedInterfaces()}
public void setDependencies(Map<String,ComponentDescriptor> dependencies)
dependencies
- the dependencies of this componentpublic void setSyntax(Syntax syntax)
syntax
- the syntax to set
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |