Skip navigation links
B F G O R U V W 

B

buildComponents(DocumentReference) - Method in interface org.xwiki.component.wiki.WikiComponentBuilder
Build the components defined in a document XObjects.
buildComponents(ObjectReference) - Method in interface org.xwiki.component.wiki.WikiObjectComponentBuilder
Build the components that is linked to the given ObjectReference.

F

fromString(String) - Static method in enum org.xwiki.component.wiki.WikiComponentScope
Convert between a string representation of a Macro scope and its matching enum.

G

getAuthorReference() - Method in interface org.xwiki.component.wiki.WikiComponent
Get the reference to the author of the document this component instance is bound to.
getClassReference() - Method in interface org.xwiki.component.wiki.WikiObjectComponentBuilder
Get the class that should trigger buildComponents(ObjectReference) when one XObject implementing this very class is added, updated or deleted in the wiki.
getDocumentReference() - Method in interface org.xwiki.component.wiki.WikiComponent
Get the reference of the document this component instance is bound to.
getDocumentReferences() - Method in interface org.xwiki.component.wiki.WikiComponentBuilder
Get the list of documents holding components.
getEntityReference() - Method in interface org.xwiki.component.wiki.WikiComponent
Get the entity reference of the bounded component instance.
getRoleHint() - Method in interface org.xwiki.component.wiki.WikiComponent
 
getRoleType() - Method in interface org.xwiki.component.wiki.WikiComponent
 
getScope() - Method in interface org.xwiki.component.wiki.WikiComponent
 

O

org.xwiki.component.wiki - package org.xwiki.component.wiki
 

R

registerWikiComponent(WikiComponent) - Method in interface org.xwiki.component.wiki.WikiComponentManager
Registers the passed component against the underlying component repository.

U

unregisterWikiComponents(DocumentReference) - Method in interface org.xwiki.component.wiki.WikiComponentManager
Unregisters the wiki component(s) associated with the passed reference.
unregisterWikiComponents(EntityReference) - Method in interface org.xwiki.component.wiki.WikiComponentManager
Just as WikiComponentManager.unregisterWikiComponents(DocumentReference), unregisters the wiki component(s) associated with the passed reference.

V

valueOf(String) - Static method in enum org.xwiki.component.wiki.WikiComponentScope
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.xwiki.component.wiki.WikiComponentScope
Returns an array containing the constants of this enum type, in the order they are declared.

W

WikiComponent - Interface in org.xwiki.component.wiki
Represents the definition of a wiki component implementation.
WikiComponentBuilder - Interface in org.xwiki.component.wiki
Allows to provide a list of documents holding one or more WikiComponent, and to build components from those documents.
WikiComponentException - Exception in org.xwiki.component.wiki
A generic exception thrown by this module, usually a wrapper around lower level exceptions.
WikiComponentException(String) - Constructor for exception org.xwiki.component.wiki.WikiComponentException
Constructor of this exception.
WikiComponentException(String, Throwable) - Constructor for exception org.xwiki.component.wiki.WikiComponentException
Constructor of this exception.
WikiComponentManager - Interface in org.xwiki.component.wiki
A WikiComponentManager is responsible for registering and unregistering components that are defined as wiki pages.
WikiComponentRuntimeException - Exception in org.xwiki.component.wiki
A generic runtime exception thrown by this module, usually a wrapper around lower level exceptions.
WikiComponentRuntimeException(String) - Constructor for exception org.xwiki.component.wiki.WikiComponentRuntimeException
Constructor of this exception.
WikiComponentRuntimeException(String, Throwable) - Constructor for exception org.xwiki.component.wiki.WikiComponentRuntimeException
Constructor of this exception.
WikiComponentScope - Enum in org.xwiki.component.wiki
The scope of a WikiComponent, i.e.
WikiObjectComponentBuilder - Interface in org.xwiki.component.wiki
Allows to build one or more WikiComponent based on the XObjects contained in an EntityReference.
B F G O R U V W 
Skip navigation links

Copyright © 2004–2021 XWiki. All rights reserved.