Package | Description |
---|---|
com.xpn.xwiki.api | |
com.xpn.xwiki.objects |
Modifier and Type | Field and Description |
---|---|
protected Object |
Document.currentObj
Convenience object used by object related methods.
|
Modifier and Type | Method and Description |
---|---|
Object |
Document.addObjectFromRequest() |
Object |
Document.addObjectFromRequest(String className) |
Object |
Document.addObjectFromRequest(String className,
String prefix) |
Object |
Document.getFirstObject(String fieldname)
Get the first object that contains the given fieldname
|
Object |
Util.getNull()
Get a Null value.
|
Object |
Document.getObject(ObjectReference objectReference) |
Object |
Document.getObject(String classname)
Get the first object matching the given classname
|
Object |
Document.getObject(String classname,
boolean create)
get the object of the given className.
|
Object |
Document.getObject(String classname,
int nb)
Get the object matching the given classname and given object number
|
Object |
Document.getObject(String classname,
String key,
String value)
Get the first object of a given classname that has a field name matching the given value When none found this
method will return null
|
Object |
Document.getObject(String classname,
String key,
String value,
boolean failover)
Get the first object of a given classname that has a field name matching the given value
|
Object |
XWiki.getObjectFromRequest(String className)
API to create an object from the request The parameters are the ones that are created from
doc.display("field","edit") calls
|
Object |
Class.newObject() |
Object |
Document.newObject(String classname)
Creates a New XWiki Object of the given classname
|
Object |
Document.updateObjectFromRequest(String className) |
Object |
Document.updateObjectFromRequest(String className,
String prefix) |
Modifier and Type | Method and Description |
---|---|
List<Object> |
Document.addObjectsFromRequest(String className) |
List<Object> |
Document.addObjectsFromRequest(String className,
String prefix) |
Vector<Object> |
Document.getComments() |
Vector<Object> |
Document.getComments(boolean asc) |
Vector<Object> |
Document.getObjects(String className)
Get the list of objects for a given classname classname
|
Vector<Object> |
Document.getObjects(String classname,
String key,
String value)
Select a subset of objects from a given class, filtered on a "key = value" criteria.
|
protected Vector<Object> |
Document.getXObjects(List<BaseObject> objects) |
Map<String,Vector<Object>> |
Document.getxWikiObjects()
Get the list of all objects available in this document organized in a Map by classname
|
List<Object> |
Document.updateObjectsFromRequest(String className) |
List<Object> |
Document.updateObjectsFromRequest(String className,
String prefix) |
Modifier and Type | Method and Description |
---|---|
String |
Document.display(String fieldname,
Object obj)
Displays the given field of the given object The display mode will be decided depending on page context (edit or
inline context will display in edit, view context in view) This function can return html inside and html macro
|
String |
Document.display(String fieldname,
String mode,
Object obj)
Displays the given field of the given object in the given mode.
|
String |
Document.display(String fieldname,
String type,
Object obj,
String wrappingSyntaxId)
Displays the given field of the given object using the given mode and syntax rendering The display mode will be
decided depending on page context (edit or inline context will display in edit, view context in view) This
function can return html inside and html macro
|
String |
Document.display(String fieldname,
String mode,
String prefix,
Object obj)
Displays the given field of the given object in the given mode.
|
String |
Document.displayPrettyName(String fieldname,
boolean showMandatory,
boolean before,
Object obj)
Displays the pretty name of the given field of the given object.
|
String |
Document.displayPrettyName(String fieldname,
boolean showMandatory,
Object obj)
Displays the pretty name of the given field of the given object.
|
String |
Document.displayPrettyName(String fieldname,
Object obj)
Displays the pretty name of the given field of the given object.
|
String |
Document.displayTooltip(String fieldname,
Object obj)
Displays the tooltip of the given field of the given object.
|
List<Property> |
Class.getDeprecatedObjectProperties(Object object)
Retrieves deprecated properties of the given object compared to the class.
|
List<String> |
Class.getDeprecatedObjectPropertyNames(Object object)
Get the names of deprecated properties of the given object compared to the class.
|
List<PropertyClass> |
Class.getDisabledObjectProperties(Object object)
Get the list of disabled properties that exist in a given object.
|
List<String> |
Class.getDisabledObjectPropertyNames(Object object)
Get the names of the class properties that are disabled, and exist in the given object.
|
Object |
Document.getValue(String fieldName,
Object object) |
boolean |
Document.removeObject(Object object)
Remove an XObject from the document.
|
void |
Document.set(String fieldname,
Object value,
Object obj) |
void |
Document.use(Object object)
Setting the current object to the given object.
|
Modifier and Type | Method and Description |
---|---|
Object |
BaseObject.newObjectApi(BaseObject obj,
XWikiContext context) |
Copyright © 2004–2021 XWiki. All rights reserved.