Class OutputText


  • public class OutputText
    extends Object
    Content of text message to display or print. It conveys information related to the content of the text message and its format. All the data elements related to the format of the text to display or print are parameters valid for the whole text content.
    • Constructor Detail

      • OutputText

        public OutputText()
    • Method Detail

      • text

        public OutputText text​(String text)
        Content of text message to display, print or play.
        Parameters:
        text - Content of text message to display, print or play.
        Returns:
        the current OutputText instance, allowing for method chaining
      • getText

        public String getText()
        Content of text message to display, print or play.
        Returns:
        text Content of text message to display, print or play.
      • setText

        public void setText​(String text)
        Content of text message to display, print or play.
        Parameters:
        text - Content of text message to display, print or play.
      • characterSet

        public OutputText characterSet​(Integer characterSet)
        Character height of the text string to display or print. Absence of this data element means the characters have normal height.
        Parameters:
        characterSet - Character height of the text string to display or print. Absence of this data element means the characters have normal height.
        Returns:
        the current OutputText instance, allowing for method chaining
      • getCharacterSet

        public Integer getCharacterSet()
        Character height of the text string to display or print. Absence of this data element means the characters have normal height.
        Returns:
        characterSet Character height of the text string to display or print. Absence of this data element means the characters have normal height.
      • setCharacterSet

        public void setCharacterSet​(Integer characterSet)
        Character height of the text string to display or print. Absence of this data element means the characters have normal height.
        Parameters:
        characterSet - Character height of the text string to display or print. Absence of this data element means the characters have normal height.
      • startRow

        public OutputText startRow​(Integer startRow)
        Row where the text string has to be displayed or printed.
        Parameters:
        startRow - Row where the text string has to be displayed or printed.
        Returns:
        the current OutputText instance, allowing for method chaining
      • getStartRow

        public Integer getStartRow()
        Row where the text string has to be displayed or printed. minimum: 1 maximum: 500
        Returns:
        startRow Row where the text string has to be displayed or printed.
      • setStartRow

        public void setStartRow​(Integer startRow)
        Row where the text string has to be displayed or printed.
        Parameters:
        startRow - Row where the text string has to be displayed or printed.
      • startColumn

        public OutputText startColumn​(Integer startColumn)
        Column where the text string has to be displayed or printed.
        Parameters:
        startColumn - Column where the text string has to be displayed or printed.
        Returns:
        the current OutputText instance, allowing for method chaining
      • getStartColumn

        public Integer getStartColumn()
        Column where the text string has to be displayed or printed. minimum: 1 maximum: 500
        Returns:
        startColumn Column where the text string has to be displayed or printed.
      • setStartColumn

        public void setStartColumn​(Integer startColumn)
        Column where the text string has to be displayed or printed.
        Parameters:
        startColumn - Column where the text string has to be displayed or printed.
      • characterWidth

        public OutputText characterWidth​(CharacterWidth characterWidth)
        characterWidth
        Parameters:
        characterWidth -
        Returns:
        the current OutputText instance, allowing for method chaining
      • getCharacterWidth

        public CharacterWidth getCharacterWidth()
        Get characterWidth
        Returns:
        characterWidth
      • setCharacterWidth

        public void setCharacterWidth​(CharacterWidth characterWidth)
        characterWidth
        Parameters:
        characterWidth -
      • characterHeight

        public OutputText characterHeight​(CharacterHeight characterHeight)
        characterHeight
        Parameters:
        characterHeight -
        Returns:
        the current OutputText instance, allowing for method chaining
      • getCharacterHeight

        public CharacterHeight getCharacterHeight()
        Get characterHeight
        Returns:
        characterHeight
      • setCharacterHeight

        public void setCharacterHeight​(CharacterHeight characterHeight)
        characterHeight
        Parameters:
        characterHeight -
      • characterStyle

        public OutputText characterStyle​(CharacterStyle characterStyle)
        characterStyle
        Parameters:
        characterStyle -
        Returns:
        the current OutputText instance, allowing for method chaining
      • getCharacterStyle

        public CharacterStyle getCharacterStyle()
        Get characterStyle
        Returns:
        characterStyle
      • setCharacterStyle

        public void setCharacterStyle​(CharacterStyle characterStyle)
        characterStyle
        Parameters:
        characterStyle -
      • alignment

        public OutputText alignment​(Alignment alignment)
        alignment
        Parameters:
        alignment -
        Returns:
        the current OutputText instance, allowing for method chaining
      • getAlignment

        public Alignment getAlignment()
        Get alignment
        Returns:
        alignment
      • setAlignment

        public void setAlignment​(Alignment alignment)
        alignment
        Parameters:
        alignment -
      • endOfLineFlag

        public OutputText endOfLineFlag​(Boolean endOfLineFlag)
        Indicates if the text is at the end of a line. Allows the display or the print of a new line and a carry-over return characters after the formatted text.
        Parameters:
        endOfLineFlag - Indicates if the text is at the end of a line. Allows the display or the print of a new line and a carry-over return characters after the formatted text.
        Returns:
        the current OutputText instance, allowing for method chaining
      • getEndOfLineFlag

        public Boolean getEndOfLineFlag()
        Indicates if the text is at the end of a line. Allows the display or the print of a new line and a carry-over return characters after the formatted text.
        Returns:
        endOfLineFlag Indicates if the text is at the end of a line. Allows the display or the print of a new line and a carry-over return characters after the formatted text.
      • setEndOfLineFlag

        public void setEndOfLineFlag​(Boolean endOfLineFlag)
        Indicates if the text is at the end of a line. Allows the display or the print of a new line and a carry-over return characters after the formatted text.
        Parameters:
        endOfLineFlag - Indicates if the text is at the end of a line. Allows the display or the print of a new line and a carry-over return characters after the formatted text.
      • includeNullValues

        public OutputText includeNullValues​(boolean includeNullValues)
        Configures whether null values are explicitly serialized in the JSON payload. Default is false.
      • isIncludeNullValues

        public boolean isIncludeNullValues()
        Returns whether null values are explicitly serialized in the JSON payload.
      • setIncludeNullValues

        public void setIncludeNullValues​(boolean includeNullValues)
        Sets whether null values should be explicitly serialized in the JSON payload. Default is false.
      • equals

        public boolean equals​(Object o)
        Return true if this OutputText object is equal to o.
        Overrides:
        equals in class Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object
      • getExplicitNulls

        public Map<String,​Object> getExplicitNulls()
        Returns a map of properties to be merged into the JSON payload as explicit null values.
      • fromJson

        public static OutputText fromJson​(String jsonString)
                                   throws com.fasterxml.jackson.core.JsonProcessingException
        Create an instance of OutputText given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of OutputText
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to OutputText
      • toJson

        public String toJson()
                      throws com.fasterxml.jackson.core.JsonProcessingException
        Convert an instance of OutputText to an JSON string
        Returns:
        JSON string
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException