@Role
public interface SheetManager
Modifier and Type | Method and Description |
---|---|
List<DocumentReference> |
getSheets(DocumentModelBridge document,
String action)
Returns the list of sheets available for a given XWiki document in the current execution context.
|
default boolean |
isSheetForced()
Indicate if the sheet system should be used (instead of old edit modes and #include based dispay).
|
List<DocumentReference> getSheets(DocumentModelBridge document, String action)
Note: We can't use a document reference because the document might have unsaved objects. The create forms usually display an unsaved document that has some objects attached.
If this method fails for some reason to retrieve the sheets it shound't throw an exception but return an empty list and log an appropriate warning message instead.
document
- a XWiki documentaction
- the action for which to retrieve the list of sheets ('view', 'edit' etc.); you can pass
null
or an empty string as a substitute for any actiondefault boolean isSheetForced()
sheet
parameter;Copyright © 2004–2022 XWiki. All rights reserved.