Class ClassSheetPage


  • public class ClassSheetPage
    extends ViewPage
    Represents the sheet used to display information about a XWiki class.
    Since:
    3.4M1
    Version:
    $Id: 7c41c1d5f1d8644b4b4cf6c29b8531349f4d4a81 $
    • Constructor Detail

      • ClassSheetPage

        public ClassSheetPage()
    • Method Detail

      • clickTemplateLink

        public ViewPage clickTemplateLink()
        Clicks on the template link and returns the template page
        Returns:
        the page that represents the class template
      • clickSheetLink

        public ViewPage clickSheetLink()
        Clicks on the link to view the class sheet.
        Returns:
        the page that represents the class sheet
      • clickDefineClassLink

        public ClassEditPage clickDefineClassLink()
        Clicks on the link to define the class. This link is visible only if the class has no properties yet.
        Returns:
        the class editor
      • clickEditClassLink

        public ClassEditPage clickEditClassLink()
        Clicks on the link to edit the class. This link is visible only if the class has properties.
        Returns:
        the class editor
      • hasProperty

        public boolean hasProperty​(String name,
                                   String prettyName,
                                   String type)
        Parameters:
        name - the property name
        prettyName - the property pretty name
        type - the property type
        Returns:
        true if the sheet lists the specified property, false otherwise
      • clickCreateSheetButton

        public ClassSheetPage clickCreateSheetButton()
        Clicks on the button to create a sheet for the class that is being displayed.
        Returns:
        the current page, after it is reloaded
      • clickBindSheetLink

        public ClassSheetPage clickBindSheetLink()
        Clicks on the link to bind the class to its sheet.
        Returns:
        the current page, after it is reloaded
      • clickCreateTemplateButton

        public ClassSheetPage clickCreateTemplateButton()
        Clicks on the button to create the class template.
        Returns:
        the current page, after it is reloaded
      • clickAddObjectToTemplateLink

        public ClassSheetPage clickAddObjectToTemplateLink()
        Clicks on the link to add an instance of the class to the template document.
        Returns:
        the current page, after it is reloaded
      • clickCreateDocumentButton

        public InlinePage clickCreateDocumentButton()
        Clicks the button to create a new document based on the class template.
        Returns:
        the in-line edit mode for the new document
      • createNewDocument

        public InlinePage createNewDocument​(String spaceName,
                                            String pageName)
        Creates a new document with the specified name, in the specified space, based on the class template.
        Parameters:
        spaceName - the name of the space where to create the new document
        pageName - the name of the new document
        Returns:
        the in-line mode for the new document
      • hasDocument

        public boolean hasDocument​(String documentName)
        Parameters:
        documentName - the name of a document
        Returns:
        true if the specified document is listed as having an object of the class being viewed, false otherwise