Class OperationItem


  • public class OperationItem
    extends Object
    Used to specify all the properties you want for a content structure entry that is to be created, including the actions it will trigger. An entry can contain any number of the specified subelements you want in the order you want them. All subelements represent a type of action that will be triggered when the entry is clicked on and that will be executed in succession.
    • Constructor Detail

      • OperationItem

        public OperationItem()
    • Method Detail

      • getBold

        @Nullable
        public @Nullable Boolean getBold()
        If this value is set to true, the element's name will be shown in bold.
        Returns:
        bold
      • setBold

        public void setBold​(Boolean bold)
      • getColor

        @Nullable
        public @Nullable String getColor()
        Used to set the colour that will be used to display the element's name. The hereby defined color needs to be specified as a hexadecimal RGB value with a number sign before it.
        Returns:
        color
      • setColor

        public void setColor​(String color)
      • getIsOpen

        @Nullable
        public @Nullable Boolean getIsOpen()
        If this value is set to true, the element will already be expanded when the document is opened.
        Returns:
        isOpen
      • setIsOpen

        public void setIsOpen​(Boolean isOpen)
      • getItalic

        @Nullable
        public @Nullable Boolean getItalic()
        If this value is set to true, the element's name will be shown in italics.
        Returns:
        italic
      • setItalic

        public void setItalic​(Boolean italic)
      • getItemName

        @Nullable
        public @Nullable String getItemName()
        The name of the new entry in the content structure that should be placed relative to the selected path.
        Returns:
        itemName
      • setItemName

        public void setItemName​(String itemName)
      • getPath

        @Nullable
        public @Nullable String getPath()
        The element paths are made of the visible names of the entries in the content structure separated with forward slashes (/), starting with an initial slash.
        Returns:
        path
      • setPath

        public void setPath​(String path)
      • getPathPosition

        @Nullable
        public @Nullable OperationItem.PathPositionEnum getPathPosition()
        Selects the position where the entry should be created. The path passed in \"path\" will be interpreted based on this value. * before = An entry will be generated on the same level before the entry that was selected with \"path. * inplace = The entry selected with \"path\" will be treated as a parent element and will contain the new generated entry. * after = An entry will be generated on the same level after the entry that was selected with \"path.
        Returns:
        pathPosition
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object