Package net.webpdf.wsclient.openapi
Class OperationItem
- java.lang.Object
-
- net.webpdf.wsclient.openapi.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.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classOperationItem.PathPositionEnumSelects the position where the entry should be created.
-
Field Summary
Fields Modifier and Type Field Description static StringJSON_PROPERTY_ACTIONSstatic StringJSON_PROPERTY_BOLDstatic StringJSON_PROPERTY_COLORstatic StringJSON_PROPERTY_IS_OPENstatic StringJSON_PROPERTY_ITALICstatic StringJSON_PROPERTY_ITEM_NAMEstatic StringJSON_PROPERTY_PATHstatic StringJSON_PROPERTY_PATH_POSITION
-
Constructor Summary
Constructors Constructor Description OperationItem()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description OperationItemactions(List<OperationActionEvent> actions)OperationItemaddActionsItem(OperationActionEvent actionsItem)OperationItembold(Boolean bold)OperationItemcolor(String color)booleanequals(Object o)@Nullable List<OperationActionEvent>getActions()Get actions@Nullable BooleangetBold()If this value is set to true, the element's name will be shown in bold.@Nullable StringgetColor()Used to set the colour that will be used to display the element's name.@Nullable BooleangetIsOpen()If this value is set to true, the element will already be expanded when the document is opened.@Nullable BooleangetItalic()If this value is set to true, the element's name will be shown in italics.@Nullable StringgetItemName()The name of the new entry in the content structure that should be placed relative to the selected path.@Nullable StringgetPath()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.@Nullable OperationItem.PathPositionEnumgetPathPosition()Selects the position where the entry should be created.inthashCode()OperationItemisOpen(Boolean isOpen)OperationItemitalic(Boolean italic)OperationItemitemName(String itemName)OperationItempath(String path)OperationItempathPosition(OperationItem.PathPositionEnum pathPosition)voidsetActions(List<OperationActionEvent> actions)voidsetBold(Boolean bold)voidsetColor(String color)voidsetIsOpen(Boolean isOpen)voidsetItalic(Boolean italic)voidsetItemName(String itemName)voidsetPath(String path)voidsetPathPosition(OperationItem.PathPositionEnum pathPosition)StringtoString()
-
-
-
Field Detail
-
JSON_PROPERTY_ACTIONS
public static final String JSON_PROPERTY_ACTIONS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_BOLD
public static final String JSON_PROPERTY_BOLD
- See Also:
- Constant Field Values
-
JSON_PROPERTY_COLOR
public static final String JSON_PROPERTY_COLOR
- See Also:
- Constant Field Values
-
JSON_PROPERTY_IS_OPEN
public static final String JSON_PROPERTY_IS_OPEN
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ITALIC
public static final String JSON_PROPERTY_ITALIC
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ITEM_NAME
public static final String JSON_PROPERTY_ITEM_NAME
- See Also:
- Constant Field Values
-
JSON_PROPERTY_PATH
public static final String JSON_PROPERTY_PATH
- See Also:
- Constant Field Values
-
JSON_PROPERTY_PATH_POSITION
public static final String JSON_PROPERTY_PATH_POSITION
- See Also:
- Constant Field Values
-
-
Method Detail
-
actions
public OperationItem actions(List<OperationActionEvent> actions)
-
addActionsItem
public OperationItem addActionsItem(OperationActionEvent actionsItem)
-
getActions
@Nullable public @Nullable List<OperationActionEvent> getActions()
Get actions- Returns:
- actions
-
setActions
public void setActions(List<OperationActionEvent> actions)
-
bold
public OperationItem bold(Boolean bold)
-
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)
-
color
public OperationItem color(String color)
-
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)
-
isOpen
public OperationItem isOpen(Boolean isOpen)
-
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)
-
italic
public OperationItem italic(Boolean italic)
-
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)
-
itemName
public OperationItem itemName(String itemName)
-
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)
-
path
public OperationItem path(String path)
-
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)
-
pathPosition
public OperationItem pathPosition(OperationItem.PathPositionEnum pathPosition)
-
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
-
setPathPosition
public void setPathPosition(OperationItem.PathPositionEnum pathPosition)
-
-