|
Nuxeo ECM Projects 5.4.3-SNAPSHOT | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.nuxeo.runtime.model.impl.ExtensionImpl
public class ExtensionImpl
Constructor Summary | |
---|---|
ExtensionImpl()
|
Method Summary | |
---|---|
void |
dispose()
Disposes this extension. |
static ExtensionImpl |
fromXML(RuntimeContext context,
String xml)
|
ComponentInstance |
getComponent()
Gets the component instance owning this extension. |
RuntimeContext |
getContext()
Gets the context of the component who contributed this extension. |
Object[] |
getContributions()
Gets the extension contribution objects. |
String |
getDocumentation()
Gets any comment on this extension. |
Element |
getElement()
Gets the DOM element held by this extension. |
String |
getExtensionPoint()
Gets the extension point name where this extension should be contributed. |
String |
getId()
Identifies the extension inside the contributing component. |
ComponentName |
getTargetComponent()
Gets the component name where this extension should be contributed. |
void |
setComponent(ComponentInstance component)
Sets the component owning this extension. |
void |
setContributions(Object[] contributions)
Sets the contribution objects. |
void |
setElement(Element element)
Sets the DOM element that defines this extension. |
String |
toString()
|
String |
toXML()
Gets the XML string for this extension. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public ExtensionImpl()
Method Detail |
---|
public void dispose()
Extension
This will erase any data held by the extension.
dispose
in interface Extension
public Element getElement()
Extension
The DOM element correspond to the "extension" element in the component XML descriptor.
getElement
in interface Extension
public void setElement(Element element)
Extension
setElement
in interface Extension
element
- the extension DOM elementpublic String getExtensionPoint()
Extension
getExtensionPoint
in interface Extension
public ComponentName getTargetComponent()
Extension
getTargetComponent
in interface Extension
public Object[] getContributions()
Extension
These objects are generated by the extension point from the DOM element and then attached to the extension.
getContributions
in interface Extension
public void setContributions(Object[] contributions)
Extension
This method is used by the extension point to attach the contribution objects to the extension.
setContributions
in interface Extension
contributions
- the contribution objectspublic void setComponent(ComponentInstance component)
Extension
setComponent
in interface Extension
component
- the component instance owning this extensionpublic ComponentInstance getComponent()
Extension
getComponent
in interface Extension
public RuntimeContext getContext()
Extension
getContext
in interface Extension
public String getId()
Extension
The id is never null. If the user is not specifying an ID, one will be generated as follow: componentName#targetExtensionPoint.randomNumber
getId
in interface Extension
public String getDocumentation()
Extension
Comments can be used to document extensions.
Comments should be short because they are stored in memory.
getDocumentation
in interface Extension
public String toString()
toString
in class Object
public String toXML()
toXML
in interface Extension
public static ExtensionImpl fromXML(RuntimeContext context, String xml) throws Exception
Exception
|
Nuxeo ECM Projects 5.4.3-SNAPSHOT | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |