Interface IScriptStyle


  • public interface IScriptStyle
    Definition of the script style methods
    Since:
    3.3
    • Method Detail

      • getVisibleFormat

        java.lang.String getVisibleFormat()
        Get format to hide in. Should be one of org.eclipse.birt.report.model.api.elements.DesignChoiceConstants.FORMAT_TYPE_ALL org.eclipse.birt.report.model.api.elements.DesignChoiceConstants.FORMAT_TYPE_VIEWER org.eclipse.birt.report.model.api.elements.DesignChoiceConstants.FORMAT_TYPE_EMAIL org.eclipse.birt.report.model.api.elements.DesignChoiceConstants.FORMAT_TYPE_PRINT org.eclipse.birt.report.model.api.elements.DesignChoiceConstants.FORMAT_TYPE_PDF org.eclipse.birt.report.model.api.elements.DesignChoiceConstants.FORMAT_TYPE_RTF org.eclipse.birt.report.model.api.elements.DesignChoiceConstants.FORMAT_TYPE_REPORTLET org.eclipse.birt.report.model.api.elements.DesignChoiceConstants.FORMAT_TYPE_EXCEL org.eclipse.birt.report.model.api.elements.DesignChoiceConstants.FORMAT_TYPE_WORD org.eclipse.birt.report.model.api.elements.DesignChoiceConstants.FORMAT_TYPE_POWERPOINT
        Returns:
        Return format to hide in. Should be one of
      • setVisibleFormat

        void setVisibleFormat​(java.lang.String format)
        Set format to hide in. Should be one of org.eclipse.birt.report.model.api.elements.DesignChoiceConstants.FORMAT_TYPE_ALL org.eclipse.birt.report.model.api.elements.DesignChoiceConstants.FORMAT_TYPE_VIEWER org.eclipse.birt.report.model.api.elements.DesignChoiceConstants.FORMAT_TYPE_EMAIL org.eclipse.birt.report.model.api.elements.DesignChoiceConstants.FORMAT_TYPE_PRINT org.eclipse.birt.report.model.api.elements.DesignChoiceConstants.FORMAT_TYPE_PDF org.eclipse.birt.report.model.api.elements.DesignChoiceConstants.FORMAT_TYPE_RTF org.eclipse.birt.report.model.api.elements.DesignChoiceConstants.FORMAT_TYPE_REPORTLET org.eclipse.birt.report.model.api.elements.DesignChoiceConstants.FORMAT_TYPE_EXCEL org.eclipse.birt.report.model.api.elements.DesignChoiceConstants.FORMAT_TYPE_WORD org.eclipse.birt.report.model.api.elements.DesignChoiceConstants.FORMAT_TYPE_POWERPOINT
        Parameters:
        format -
      • getLetterSpacing

        java.lang.String getLetterSpacing()
        Get the letter spacing
        Returns:
        Return the letter spacing
      • setLetterSpacing

        void setLetterSpacing​(java.lang.String spacing)
        Set the letter spacing
        Parameters:
        spacing -
      • getLineHeight

        java.lang.String getLineHeight()
        Get the line height
        Returns:
        Return the line height
      • setLineHeight

        void setLineHeight​(java.lang.String lineHeight)
        Set the line height
        Parameters:
        lineHeight -
      • getTextAlign

        java.lang.String getTextAlign()
        Get the text alignment. Valid return types are LEFT, RIGHT, CENTER and JUSTIFY.
        Returns:
        Return the text alignment
      • setTextAlign

        void setTextAlign​(java.lang.String align)
        Set the text alignment. Valid return types are LEFT, RIGHT, CENTER and JUSTIFY.
        Parameters:
        align -
      • getTextIndent

        java.lang.String getTextIndent()
        Get the text indent
        Returns:
        Return the text indent
      • setTextIndent

        void setTextIndent​(java.lang.String indent)
        Set text indent
        Parameters:
        indent -
      • getTextTransform

        java.lang.String getTextTransform()
        Get the text transform. Valid return values are NONE, CAPITALIZE, UPPERCASE and LOWERCASE.
        Returns:
        Return the text transform
      • setTextTransform

        void setTextTransform​(java.lang.String transform)
        Set the text transform. Valid transform values are NONE, CAPITALIZE, UPPERCASE and LOWERCASE.
        Parameters:
        transform -
      • getVerticalAlign

        java.lang.String getVerticalAlign()
        Get the vertical alignment. Valid return values are BASELINE, SUB, SUPER, TOP, TEXT_TOP, MIDDLE, BOTTOM and TEXT_BOTTOM
        Returns:
        Return the vertical alignment
      • setVerticalAlign

        void setVerticalAlign​(java.lang.String valign)
        Set the vertical alignment. Valid values are BASELINE, SUB, SUPER, TOP, TEXT_TOP, MIDDLE, BOTTOM and TEXT_BOTTOM
        Parameters:
        valign -
      • getWhiteSpace

        java.lang.String getWhiteSpace()
        Get the whitespace. Valid return values are NORMAL, PRE and NOWRAP
        Returns:
        Return the whitespace option
      • setWhiteSpace

        void setWhiteSpace​(java.lang.String whitespace)
        Set the whitespace. The values retruned can be NORMAL, PRE and NOWRAP
        Parameters:
        whitespace -
      • getWordSpacing

        java.lang.String getWordSpacing()
        Get the word spacing
        Returns:
        Return the word spacing
      • setWordSpacing

        void setWordSpacing​(java.lang.String wordspacing)
        Set the word spacing
        Parameters:
        wordspacing -
      • getColor

        java.lang.String getColor()
        Get the font color
        Returns:
        Return the font color
      • setColor

        void setColor​(java.lang.String color)
        Set the font color
        Parameters:
        color -
      • getBackgroundAttachement

        @Deprecated
        java.lang.String getBackgroundAttachement()
        Deprecated.
        replaced by getBackgroundAttachment()
        Get the attachement type (either SCROLL or FIXED)
        Returns:
        Return the attachment type
      • setBackgroundAttachement

        @Deprecated
        void setBackgroundAttachement​(java.lang.String attachement)
        Deprecated.
        replaced by setBackgroundAttachment( String attachment )
        Set the attachement type (either SCROLL or FIXED)
        Parameters:
        attachement -
      • getBackgroundAttachment

        java.lang.String getBackgroundAttachment()
        Get the attachment type (either SCROLL or FIXED)
        Returns:
        Return the attachement type
      • setBackgroundAttachment

        void setBackgroundAttachment​(java.lang.String attachment)
        Set the attachment type (either SCROLL or FIXED)
        Parameters:
        attachment -
      • getBackgroundColor

        java.lang.String getBackgroundColor()
        Get the background color
        Returns:
        Return the background color
      • setBackgroundColor

        void setBackgroundColor​(java.lang.String color)
        Set the background color
        Parameters:
        color -
      • getBackgroundImage

        java.lang.String getBackgroundImage()
        Get the background image URI
        Returns:
        Return the background image URI
      • setBackgroundImage

        void setBackgroundImage​(java.lang.String imageURI)
        Set the background image URI
        Parameters:
        imageURI -
      • getBackgroundImageType

        java.lang.String getBackgroundImageType()
        Get the background image source type
        Returns:
        Return the background image source type
      • setBackgroundImageType

        void setBackgroundImageType​(java.lang.String imageSourceType)
        Set the background image source type
        Parameters:
        imageSourceType -
      • getBackgroundRepeat

        java.lang.String getBackgroundRepeat()
        Get the background repeat type (valid types are REPEAT, REPEAT_X, REPEAT_Y and NO_REPEAT)
        Returns:
        Return the background repeat
      • setBackgroundRepeat

        void setBackgroundRepeat​(java.lang.String repeat)
        Set the background repeat type (valid types are REPEAT, REPEAT_X, REPEAT_Y and NO_REPEAT)
        Parameters:
        repeat -
      • getBorderBottomColor

        java.lang.String getBorderBottomColor()
        Get the bottom border color
        Returns:
        Return the bottom border color
      • setBorderBottomColor

        void setBorderBottomColor​(java.lang.String color)
        Set the bottom border color
        Parameters:
        color -
      • getBorderTopColor

        java.lang.String getBorderTopColor()
        Get the top border color
        Returns:
        Return the top border color
      • setBorderTopColor

        void setBorderTopColor​(java.lang.String color)
        Set the top border color
        Parameters:
        color -
      • getBorderRightColor

        java.lang.String getBorderRightColor()
        Get the right border color
        Returns:
        Return the right border color
      • setBorderRightColor

        void setBorderRightColor​(java.lang.String color)
        Set the right border color
        Parameters:
        color -
      • getBorderLeftColor

        java.lang.String getBorderLeftColor()
        Get the left border color
        Returns:
        Return the left border color
      • setBorderLeftColor

        void setBorderLeftColor​(java.lang.String color)
        Set the left border color
        Parameters:
        color -
      • getBorderBottomStyle

        java.lang.String getBorderBottomStyle()
        Get the bottom border style. Valid styles are NONE, SOLID, DOTTED, DASHED, DOUBLE, GROVE, RIDGE, INSET and OUTSET.
        Returns:
        Return the bottom border style.
      • setBorderBottomStyle

        void setBorderBottomStyle​(java.lang.String borderstyle)
        Set the bottom border style. Valid styles are NONE, SOLID, DOTTED, DASHED, DOUBLE, GROVE, RIDGE, INSET and OUTSET.
        Parameters:
        borderstyle -
      • getBorderTopStyle

        java.lang.String getBorderTopStyle()
        Get the top border style. Valid styles are NONE, SOLID, DOTTED, DASHED, DOUBLE, GROVE, RIDGE, INSET and OUTSET.
        Returns:
        Return the top border style.
      • setBorderTopStyle

        void setBorderTopStyle​(java.lang.String borderstyle)
        Set the top border style. Valid styles are NONE, SOLID, DOTTED, DASHED, DOUBLE, GROVE, RIDGE, INSET and OUTSET.
        Parameters:
        borderstyle -
      • getBorderLeftStyle

        java.lang.String getBorderLeftStyle()
        Get the left border style. Valid styles are NONE, SOLID, DOTTED, DASHED, DOUBLE, GROVE, RIDGE, INSET and OUTSET.
        Returns:
        Return the left border style.
      • setBorderLeftStyle

        void setBorderLeftStyle​(java.lang.String borderstyle)
        Set the left border style. Valid styles are NONE, SOLID, DOTTED, DASHED, DOUBLE, GROVE, RIDGE, INSET and OUTSET.
        Parameters:
        borderstyle -
      • getBorderRightStyle

        java.lang.String getBorderRightStyle()
        Get the right border style. Valid styles are NONE, SOLID, DOTTED, DASHED, DOUBLE, GROVE, RIDGE, INSET and OUTSET.
        Returns:
        Return the right border style.
      • setBorderRightStyle

        void setBorderRightStyle​(java.lang.String borderstyle)
        Set the right border style. Valid styles are NONE, SOLID, DOTTED, DASHED, DOUBLE, GROVE, RIDGE, INSET and OUTSET.
        Parameters:
        borderstyle -
      • getBorderBottomWidth

        java.lang.String getBorderBottomWidth()
        Get the bottom border width.
        Returns:
        Return the bottom border width.
      • setBorderBottomWidth

        void setBorderBottomWidth​(java.lang.String width)
        Set the bottom border width.
        Parameters:
        width -
      • getBorderTopWidth

        java.lang.String getBorderTopWidth()
        Get the top border width.
        Returns:
        Return the top border width.
      • setBorderTopWidth

        void setBorderTopWidth​(java.lang.String width)
        Set the top border width.
        Parameters:
        width -
      • getBorderLeftWidth

        java.lang.String getBorderLeftWidth()
        Get the left border width.
        Returns:
        Return the left border width.
      • setBorderLeftWidth

        void setBorderLeftWidth​(java.lang.String width)
        Set the left border width.
        Parameters:
        width -
      • getBorderRightWidth

        java.lang.String getBorderRightWidth()
        Get the left border width.
        Returns:
        Return the left border width.
      • setBorderRightWidth

        void setBorderRightWidth​(java.lang.String width)
        Set the right border width.
        Parameters:
        width -
      • getMarginBottom

        java.lang.String getMarginBottom()
        Get the bottom margin
        Returns:
        Return the bottom margin
      • setMarginBottom

        void setMarginBottom​(java.lang.String margin)
        Set the bottom margin
        Parameters:
        margin -
      • getMarginTop

        java.lang.String getMarginTop()
        Get the top margin
        Returns:
        Return the top margin
      • setMarginTop

        void setMarginTop​(java.lang.String margin)
        Set the top margin
        Parameters:
        margin -
      • getMarginLeft

        java.lang.String getMarginLeft()
        Get the left margin
        Returns:
        Return the left margin
      • setMarginLeft

        void setMarginLeft​(java.lang.String margin)
        Set the left margin
        Parameters:
        margin -
      • getMarginRight

        java.lang.String getMarginRight()
        Get the right margin
        Returns:
        Return the right margin
      • setMarginRight

        void setMarginRight​(java.lang.String margin)
        Set the right margin
        Parameters:
        margin -
      • getPaddingBottom

        java.lang.String getPaddingBottom()
        Get the bottom padding.
        Returns:
        Return the bottom padding.
      • setPaddingBottom

        void setPaddingBottom​(java.lang.String padding)
        Set the bottom padding.
        Parameters:
        padding -
      • getPaddingTop

        java.lang.String getPaddingTop()
        Get the top padding.
        Returns:
        Return the top padding.
      • setPaddingTop

        void setPaddingTop​(java.lang.String padding)
        Set the top padding.
        Parameters:
        padding -
      • getPaddingLeft

        java.lang.String getPaddingLeft()
        Get the left padding.
        Returns:
        Return the left padding.
      • setPaddingLeft

        void setPaddingLeft​(java.lang.String padding)
        Set the left padding.
        Parameters:
        padding -
      • getPaddingRight

        java.lang.String getPaddingRight()
        Get the right padding.
        Returns:
        Return the right padding.
      • setPaddingRight

        void setPaddingRight​(java.lang.String padding)
        Set the right padding.
        Parameters:
        padding -
      • getDisplay

        java.lang.String getDisplay()
        Get the display type (valid types are BLOCK, INLINE and NONE)
        Returns:
        Return the display type (valid types are BLOCK, INLINE and NONE)
      • setDisplay

        void setDisplay​(java.lang.String display)
        Set the display type (valid types are BLOCK, INLINE and NONE)
        Parameters:
        display -
      • getMasterPage

        java.lang.String getMasterPage()
        Get the master page
        Returns:
        Return the master page
      • setMasterPage

        void setMasterPage​(java.lang.String masterPage)
        Set the master page
        Parameters:
        masterPage -
      • getPageBreakBefore

        java.lang.String getPageBreakBefore()
        Get the page break before.
        Returns:
        Return the page break before.
      • setPageBreakBefore

        void setPageBreakBefore​(java.lang.String pageBreak)
        Set the page break before
        Parameters:
        pageBreak -
      • getPageBreakAfter

        java.lang.String getPageBreakAfter()
        Get the page break after.
        Returns:
        Return the page break after.
      • setPageBreakAfter

        void setPageBreakAfter​(java.lang.String pageBreak)
        Set the page break after
        Parameters:
        pageBreak -
      • getPageBreakInside

        java.lang.String getPageBreakInside()
        Get the page break inside.
        Returns:
        Return the page break inside.
      • setPageBreakInside

        void setPageBreakInside​(java.lang.String pageBreak)
        Set the page break inside
        Parameters:
        pageBreak -
      • getShowIfBlank

        java.lang.String getShowIfBlank()
        Show if blank?
        Returns:
        Show if blank?
      • setShowIfBlank

        void setShowIfBlank​(java.lang.String showIfBlank)
        Set show if blank
        Parameters:
        showIfBlank -
      • getCanShrink

        java.lang.String getCanShrink()
        Can this element shrink?
        Returns:
        Can this element shrink?
      • setCanShrink

        void setCanShrink​(java.lang.String canShrink)
        Can this element shrink?
        Parameters:
        canShrink -
      • getNumberFormat

        java.lang.String getNumberFormat()
        Get number format
        Returns:
        the number format
      • setNumberFormat

        void setNumberFormat​(java.lang.String numberFormat)
        Set the number format
        Parameters:
        numberFormat -
      • getNumberLocale

        java.lang.String getNumberLocale()
        Get the number locale
        Returns:
        number locale
      • setNumberLocale

        void setNumberLocale​(java.lang.String locale)
        Set the number locale
        Parameters:
        locale - number locale
      • getDateFormat

        java.lang.String getDateFormat()
        Get the date format
        Returns:
        date format
      • setDateFormat

        void setDateFormat​(java.lang.String dateTimeFormat)
        Set the date format
        Parameters:
        dateTimeFormat -
      • getDateLocale

        java.lang.String getDateLocale()
        Get the date locale
        Returns:
        teh date locale
      • setDateLocale

        void setDateLocale​(java.lang.String locale)
        Set the date locale
        Parameters:
        locale - the date locale
      • getStringFormat

        java.lang.String getStringFormat()
        Get the string format
        Returns:
        the string format
      • setStringFormat

        void setStringFormat​(java.lang.String stringFormat)
        Set the string format
        Parameters:
        stringFormat -
      • getStringLocale

        java.lang.String getStringLocale()
        Get the string locale
        Returns:
        the string locale
      • setStringLocale

        void setStringLocale​(java.lang.String locale)
        Set the string locale
        Parameters:
        locale - string locale
      • getFontFamily

        java.lang.String getFontFamily()
        Get the font family
        Returns:
        Return the font family
      • setFontFamily

        void setFontFamily​(java.lang.String fontFamily)
        Set the font family
        Parameters:
        fontFamily -
      • getFontStyle

        java.lang.String getFontStyle()
        Get the font style
        Returns:
        Return the font style
      • setFontStyle

        void setFontStyle​(java.lang.String fontStyle)
        Set the font style
        Parameters:
        fontStyle -
      • getFontVariant

        java.lang.String getFontVariant()
        Get the font variant
        Returns:
        Return the font variant
      • setFontVariant

        void setFontVariant​(java.lang.String fontVariant)
        Set the font variant
        Parameters:
        fontVariant -
      • getFontWeight

        java.lang.String getFontWeight()
        Get the font weight
        Returns:
        Return the font weight
      • setFontWeight

        void setFontWeight​(java.lang.String fontWeight)
        Set the font weight
        Parameters:
        fontWeight -
      • getFontSize

        java.lang.String getFontSize()
        Get the font size
        Returns:
        Return the font size
      • setFontSize

        void setFontSize​(java.lang.String fontSize)
        Set the font size
        Parameters:
        fontSize -
      • getTextUnderline

        java.lang.String getTextUnderline()
        Get the text underline
        Returns:
        Return the text underline
      • setTextUnderline

        void setTextUnderline​(java.lang.String underline)
                       throws ScriptException
        Set the text underline
        Parameters:
        underline -
        Throws:
        ScriptException
      • getTextOverline

        java.lang.String getTextOverline()
        Get the text overline
        Returns:
        Return the text overline
      • setTextOverline

        void setTextOverline​(java.lang.String overline)
                      throws ScriptException
        Set the text overline
        Parameters:
        overline -
        Throws:
        ScriptException
      • getTextLineThrough

        java.lang.String getTextLineThrough()
        Get the text line through
        Returns:
        Return the text line through
      • setTextLineThrough

        void setTextLineThrough​(java.lang.String through)
                         throws ScriptException
        Set the text line through
        Parameters:
        through -
        Throws:
        ScriptException
      • getBackgroundPositionX

        java.lang.String getBackgroundPositionX()
        Get the X (horizontal) position of the background image
        Returns:
        Return the X (horizontal) position of the background image
      • setBackgroundPositionX

        void setBackgroundPositionX​(java.lang.String x)
                             throws ScriptException
        Set the X (horizontal) position of the background image
        Parameters:
        x -
        Throws:
        ScriptException
      • getBackgroundPositionY

        java.lang.String getBackgroundPositionY()
        Get the Y (vertical) position of the background image
        Returns:
        Return the Y (vertical) position of the background image
      • setBackgroundPositionY

        void setBackgroundPositionY​(java.lang.String y)
                             throws ScriptException
        Set the Y (vertical) position of the background image
        Parameters:
        y -
        Throws:
        ScriptException