Package io.keikai.doc.io.schema.docx

Interface IDOCXRPr

All Superinterfaces:
ICTElement
All Known Implementing Classes:
DOCXParaRPr, DOCXRPr
public interface IDOCXRPr extends ICTElement
Internal Use Only.

To represent the run properties in the schema, includeing w:rPr under w:r and w:rPr under w:pPr.

Author:
Jamson Chan

  • Method Summary

    Modifier and Type
    Method
    Description
    DOCXBorder
    getBdr()
    Returns the border of the text.
    org.openxmlformats.schemas.wordprocessingml.x2006.main.CTColor
    getColor()
    Returns the color of the text.
    org.openxmlformats.schemas.wordprocessingml.x2006.main.STEm.Enum
    getEm()
    Returns the emphasis mark of the text.
    org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFitText
    getFitText()
    Returns the manual run width of the text.
    org.openxmlformats.schemas.wordprocessingml.x2006.main.STHighlightColor.Enum
    getHighlight()
    Returns the highlight color of the text.
    Double
    getKern()
    Returns the kerning of the text.
    org.openxmlformats.schemas.wordprocessingml.x2006.main.CTLanguage
    getLang()
    Returns the language of the text.
    Double
    getPosition()
    Returns the vertically raised or lowered text.
    org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFonts
    getRFonts()
    Returns the font of the text.
    String
    getRStyle()
    Returns the run style of the text.
    org.openxmlformats.schemas.wordprocessingml.x2006.main.CTShd
    getShd()
    Returns the shading of the text.
    Double
    getSpacing()
    Returns the spacing of the text.
    Double
    getSz()
    Returns the font size of the text.
    Double
    getSzCs()
    Returns the font size of the text in complex script.
    org.openxmlformats.schemas.wordprocessingml.x2006.main.CTUnderline
    getU()
    Returns the underline style of the text.
    org.openxmlformats.schemas.officeDocument.x2006.sharedTypes.STVerticalAlignRun.Enum
    getVertAlign()
    Returns the vertical alignment.
    Integer
    getW()
    Returns the character scale.
    boolean
    isB()
    Returns whether the text is bold.
    boolean
    isBCs()
    Returns whether the text is bold in complex script.
    boolean
    isCaps()
    Returns whether the text is capitalized.
    boolean
    isCs()
    Returns whether the text is complex script.
    boolean
    isDstrike()
    Returns whether the text is double strike through.
    boolean
    isEmboss()
    Returns whether the text is embossed.
    boolean
    isI()
    Returns whether the text is italic.
    boolean
    isICs()
    Returns whether the text is italic in complex script.
    boolean
    isImprint()
    Returns whether the text is imprinted.
    boolean
    isNoProof()
    Returns whether the text is no proof.
    boolean
    isOMath()
    Returns whether the text is office math.
    boolean
    isOutline()
    Returns whether the text is outline.
    boolean
    isRtl()
    Returns whether the text is right to left.
    boolean
    isShadow()
    Returns whether the text is shadow.
    boolean
    isSmallCaps()
    Returns whether the text is small caps.
    boolean
    isSnapToGrid()
    Returns whether to use document grid settings for Inter-Character spacing.
    boolean
    isSpecVanish()
    Returns whether the text is spec vanish.
    boolean
    isStrike()
    Returns whether the text is strike through.
    boolean
    isVanish()
    Returns whether the text is vanished.
    boolean
    isWebHidden()
    Returns whether the text is web hidden.
    void
    setB(boolean b)
    Sets whether the text is bold.
    void
    setBCs(boolean bCs)
    Sets whether the text is bold in complex script.
    void
    setBdr(DOCXBorder bdr)
    Sets the border of the text.
    void
    setCaps(boolean caps)
    Sets whether the text is capitalized.
    void
    setColor(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTColor color)
    Sets the color of the text.
    void
    setCs(boolean cs)
    Sets whether the text is complex script.
    void
    setDstrike(boolean dstrike)
    Sets whether the text is double strike through.
    void
    setEm(org.openxmlformats.schemas.wordprocessingml.x2006.main.STEm.Enum em)
    Sets the emphasis mark of the text.
    void
    setEmboss(boolean emboss)
    Sets whether the text is embossed.
    void
    setFitText(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFitText fitText)
    Sets the manual run width of the text.
    void
    setHighlight(org.openxmlformats.schemas.wordprocessingml.x2006.main.STHighlightColor.Enum highlight)
    Sets the highlight color of the text.
    void
    setI(boolean i)
    Sets whether the text is italic.
    void
    setICs(boolean iCs)
    Sets whether the text is italic in complex script.
    void
    setImprint(boolean imprint)
    Sets whether the text is imprinted.
    void
    setKern(Double kern)
    Sets the kerning of the text.
    void
    setLang(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTLanguage lang)
    Sets the language of the text.
    void
    setNoProof(boolean noProof)
    Sets whether the text is no proof.
    void
    setOMath(boolean oMath)
    Sets whether the text is office math.
    void
    setOutline(boolean outline)
    Sets whether the text is outline.
    void
    setPosition(Double position)
    Sets the vertically raised or lowered text.
    void
    setRFonts(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFonts rFonts)
    Sets the font of the text.
    void
    setRStyle(String rStyle)
    Sets the run style of the text.
    void
    setRtl(boolean rtl)
    Sets whether the text is right to left.
    void
    setShadow(boolean shadow)
    Sets whether the text is shadow.
    void
    setShd(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTShd shd)
    Sets the shading of the text.
    void
    setSmallCaps(boolean smallCaps)
    Sets whether the text is small caps.
    void
    setSnapToGrid(boolean snapToGrid)
    Sets whether to use document grid settings for Inter-Character spacing.
    void
    setSpacing(Double spacing)
    Sets the spacing of the text.
    void
    setSpecVanish(boolean specVanish)
    Sets whether the text is spec vanish.
    void
    setStrike(boolean strike)
    Sets whether the text is strike through.
    void
    setSz(Double sz)
    Sets the font size of the text.
    void
    setSzCs(Double szCs)
    Sets the font size of the text in complex script.
    void
    setU(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTUnderline u)
    Sets the underline style of the text.
    void
    setVanish(boolean vanish)
    Sets whether the text is vanished.
    void
    setVertAlign(org.openxmlformats.schemas.officeDocument.x2006.sharedTypes.STVerticalAlignRun.Enum vertAlign)
    Sets the vertical alignment.
    void
    setW(Integer w)
    Sets the character scale.
    void
    setWebHidden(boolean webHidden)
    Sets whether the text is web hidden.

    Methods inherited from interface io.keikai.doc.io.schema.docx.ICTElement

    getCT

  • Method Details

    • isB

      boolean isB()
      Returns whether the text is bold.

      Represents the following element tag in the schema: w:b.

      Returns:
      whether the text is bold.

    • setB

      void setB(boolean b)
      Sets whether the text is bold.

      Represents the following element tag in the schema: w:b.

      Parameters:
      b - whether the text is bold.

    • isBCs

      boolean isBCs()
      Returns whether the text is bold in complex script.

      Represents the following element tag in the schema: w:bCs.

      Returns:
      whether the text is bold in complex script.

    • setBCs

      void setBCs(boolean bCs)
      Sets whether the text is bold in complex script.

      Represents the following element tag in the schema: w:bCs.

      Parameters:
      bCs - whether the text is bold in complex script.

    • getBdr

      DOCXBorder getBdr()
      Returns the border of the text.

      Represents the following element tag in the schema: w:bdr.

      Returns:
      the border of the text.

    • setBdr

      void setBdr(DOCXBorder bdr)
      Sets the border of the text.

      Represents the following element tag in the schema: w:bdr.

      Parameters:
      bdr - the border of the text.

    • isCaps

      boolean isCaps()
      Returns whether the text is capitalized.

      Represents the following element tag in the schema: w:caps.

      Returns:
      whether the text is capitalized.

    • setCaps

      void setCaps(boolean caps)
      Sets whether the text is capitalized.

      Represents the following element tag in the schema: w:caps.

      Parameters:
      caps - whether the text is capitalized.

    • getColor

      org.openxmlformats.schemas.wordprocessingml.x2006.main.CTColor getColor()
      Returns the color of the text.

      Represents the following element tag in the schema: w:color.

      Returns:
      the color of the text.

    • setColor

      void setColor(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTColor color)
      Sets the color of the text.

      Represents the following element tag in the schema: w:color.

      Parameters:
      color - the color of the text.

    • isCs

      boolean isCs()
      Returns whether the text is complex script.

      Represents the following element tag in the schema: w:cs.

      Returns:
      whether the text is complex script.

    • setCs

      void setCs(boolean cs)
      Sets whether the text is complex script.

      Represents the following element tag in the schema: w:cs.

      Parameters:
      cs - whether the text is complex script.

    • isDstrike

      boolean isDstrike()
      Returns whether the text is double strike through.

      Represents the following element tag in the schema: w:dstrike.

      Returns:
      whether the text is double strike through.

    • setDstrike

      void setDstrike(boolean dstrike)
      Sets whether the text is double strike through.

      Represents the following element tag in the schema: w:dstrike.

      Parameters:
      dstrike - whether the text is double strike through.

    • getEm

      org.openxmlformats.schemas.wordprocessingml.x2006.main.STEm.Enum getEm()
      Returns the emphasis mark of the text.

      Represents the following element tag in the schema: w:em.

      Returns:
      the emphasis mark of the text.

    • setEm

      void setEm(org.openxmlformats.schemas.wordprocessingml.x2006.main.STEm.Enum em)
      Sets the emphasis mark of the text.

      Represents the following element tag in the schema: w:em.

      Parameters:
      em - the emphasis mark of the text.

    • isEmboss

      boolean isEmboss()
      Returns whether the text is embossed.

      Represents the following element tag in the schema: w:emboss.

      Returns:
      whether the text is embossed.

    • setEmboss

      void setEmboss(boolean emboss)
      Sets whether the text is embossed.

      Represents the following element tag in the schema: w:emboss.

      Parameters:
      emboss - whether the text is embossed.

    • getFitText

      org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFitText getFitText()
      Returns the manual run width of the text.

      Represents the following element tag in the schema: w:fitText.

      Returns:
      the manual run width of the text.

    • setFitText

      void setFitText(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFitText fitText)
      Sets the manual run width of the text.

      Represents the following element tag in the schema: w:fitText.

      Parameters:
      fitText - the manual run width of the text.

    • getHighlight

      org.openxmlformats.schemas.wordprocessingml.x2006.main.STHighlightColor.Enum getHighlight()
      Returns the highlight color of the text.

      Represents the following element tag in the schema: w:highlight.

      Returns:
      the highlight color of the text.

    • setHighlight

      void setHighlight(org.openxmlformats.schemas.wordprocessingml.x2006.main.STHighlightColor.Enum highlight)
      Sets the highlight color of the text.

      Represents the following element tag in the schema: w:highlight.

      Parameters:
      highlight - the highlight color of the text.

    • isI

      boolean isI()
      Returns whether the text is italic.

      Represents the following element tag in the schema: w:i.

      Returns:
      whether the text is italic.

    • setI

      void setI(boolean i)
      Sets whether the text is italic.

      Represents the following element tag in the schema: w:i.

      Parameters:
      i - whether the text is italic.

    • isICs

      boolean isICs()
      Returns whether the text is italic in complex script.

      Represents the following element tag in the schema: w:iCs.

      Returns:
      whether the text is italic in complex script.

    • setICs

      void setICs(boolean iCs)
      Sets whether the text is italic in complex script.

      Represents the following element tag in the schema: w:iCs.

      Parameters:
      iCs - whether the text is italic in complex script.

    • isImprint

      boolean isImprint()
      Returns whether the text is imprinted.

      Represents the following element tag in the schema: w:imprint.

      Returns:
      whether the text is imprinted.

    • setImprint

      void setImprint(boolean imprint)
      Sets whether the text is imprinted.

      Represents the following element tag in the schema: w:imprint.

      Parameters:
      imprint - whether the text is imprinted.

    • getKern

      Double getKern()
      Returns the kerning of the text.

      Represents the following element tag in the schema: w:kern.

      Returns:
      the kerning of the text.

    • setKern

      void setKern(Double kern)
      Sets the kerning of the text.

      Represents the following element tag in the schema: w:kern.

      Parameters:
      kern - the kerning of the text.

    • getLang

      org.openxmlformats.schemas.wordprocessingml.x2006.main.CTLanguage getLang()
      Returns the language of the text.

      Represents the following element tag in the schema: w:lang.

      Returns:
      the language of the text.

    • setLang

      void setLang(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTLanguage lang)
      Sets the language of the text.

      Represents the following element tag in the schema: w:lang.

      Parameters:
      lang - the language of the text.

    • isNoProof

      boolean isNoProof()
      Returns whether the text is no proof.

      Represents the following element tag in the schema: w:noProof.

      Returns:
      whether the text is no proof.

    • setNoProof

      void setNoProof(boolean noProof)
      Sets whether the text is no proof.

      Represents the following element tag in the schema: w:noProof.

      Parameters:
      noProof - whether the text is no proof.

    • isOMath

      boolean isOMath()
      Returns whether the text is office math.

      Represents the following element tag in the schema: w:oMath.

      Returns:
      whether the text is office math.

    • setOMath

      void setOMath(boolean oMath)
      Sets whether the text is office math.

      Represents the following element tag in the schema: w:oMath.

      Parameters:
      oMath - whether the text is office math.

    • isOutline

      boolean isOutline()
      Returns whether the text is outline.

      Represents the following element tag in the schema: w:outline.

      Returns:
      whether the text is outline.

    • setOutline

      void setOutline(boolean outline)
      Sets whether the text is outline.

      Represents the following element tag in the schema: w:outline.

      Parameters:
      outline - whether the text is outline.

    • getPosition

      Double getPosition()
      Returns the vertically raised or lowered text.

      Represents the following element tag in the schema: w:position.

      Returns:
      the vertically raised or lowered text.

    • setPosition

      void setPosition(Double position)
      Sets the vertically raised or lowered text.

      Represents the following element tag in the schema: w:position.

      Parameters:
      position - the vertically raised or lowered text.

    • getRFonts

      org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFonts getRFonts()
      Returns the font of the text.

      Represents the following element tag in the schema: w:rFonts.

      Returns:
      the font of the text.

    • setRFonts

      void setRFonts(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFonts rFonts)
      Sets the font of the text.

      Represents the following element tag in the schema: w:rFonts.

      Parameters:
      rFonts - the font of the text.

    • getRStyle

      String getRStyle()
      Returns the run style of the text.

      Represents the following element tag in the schema: w:rStyle.

      Returns:
      the run style of the text.

    • setRStyle

      void setRStyle(String rStyle)
      Sets the run style of the text.

      Represents the following element tag in the schema: w:rStyle.

      Parameters:
      rStyle - the run style of the text.

    • isRtl

      boolean isRtl()
      Returns whether the text is right to left.

      Represents the following element tag in the schema: w:rtl.

      Returns:
      whether the text is right to left.

    • setRtl

      void setRtl(boolean rtl)
      Sets whether the text is right to left.

      Represents the following element tag in the schema: w:rtl.

      Parameters:
      rtl - whether the text is right to left.

    • isShadow

      boolean isShadow()
      Returns whether the text is shadow.

      Represents the following element tag in the schema: w:shadow.

      Returns:
      whether the text is shadow.

    • setShadow

      void setShadow(boolean shadow)
      Sets whether the text is shadow.

      Represents the following element tag in the schema: w:shadow.

      Parameters:
      shadow - whether the text is shadow.

    • getShd

      org.openxmlformats.schemas.wordprocessingml.x2006.main.CTShd getShd()
      Returns the shading of the text.

      Represents the following element tag in the schema: w:shd.

      Returns:
      the shading of the text.

    • setShd

      void setShd(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTShd shd)
      Sets the shading of the text.

      Represents the following element tag in the schema: w:shd.

      Parameters:
      shd - the shading of the text.

    • isSmallCaps

      boolean isSmallCaps()
      Returns whether the text is small caps.

      Represents the following element tag in the schema: w:smallCaps.

      Returns:
      whether the text is small caps.

    • setSmallCaps

      void setSmallCaps(boolean smallCaps)
      Sets whether the text is small caps.

      Represents the following element tag in the schema: w:smallCaps.

      Parameters:
      smallCaps - whether the text is small caps.

    • isSnapToGrid

      boolean isSnapToGrid()
      Returns whether to use document grid settings for Inter-Character spacing.

      Represents the following element tag in the schema: w:snapToGrid.

      Returns:
      whether to use document grid settings for Inter-Character spacing.

    • setSnapToGrid

      void setSnapToGrid(boolean snapToGrid)
      Sets whether to use document grid settings for Inter-Character spacing.

      Represents the following element tag in the schema: w:snapToGrid.

      Parameters:
      snapToGrid - whether to use document grid settings for Inter-Character spacing.

    • getSpacing

      Double getSpacing()
      Returns the spacing of the text.

      Represents the following element tag in the schema: w:spacing.

      Returns:
      the spacing of the text.

    • setSpacing

      void setSpacing(Double spacing)
      Sets the spacing of the text.

      Represents the following element tag in the schema: w:spacing.

      Parameters:
      spacing - the spacing of the text.

    • isSpecVanish

      boolean isSpecVanish()
      Returns whether the text is spec vanish.

      Represents the following element tag in the schema: w:specVanish.

      Returns:
      whether the text is spec vanish.

    • setSpecVanish

      void setSpecVanish(boolean specVanish)
      Sets whether the text is spec vanish.

      Represents the following element tag in the schema: w:specVanish.

      Parameters:
      specVanish - whether the text is spec vanish.

    • isStrike

      boolean isStrike()
      Returns whether the text is strike through.

      Represents the following element tag in the schema: w:strike.

      Returns:
      whether the text is strike through.

    • setStrike

      void setStrike(boolean strike)
      Sets whether the text is strike through.

      Represents the following element tag in the schema: w:strike.

      Parameters:
      strike - whether the text is strike through.

    • getSz

      Double getSz()
      Returns the font size of the text.

      Represents the following element tag in the schema: w:sz.

      Returns:
      the font size of the text.

    • setSz

      void setSz(Double sz)
      Sets the font size of the text.

      Represents the following element tag in the schema: w:sz.

      Parameters:
      sz - the font size of the text.

    • getSzCs

      Double getSzCs()
      Returns the font size of the text in complex script.

      Represents the following element tag in the schema: w:szCs.

      Returns:
      the font size of the text in complex script.

    • setSzCs

      void setSzCs(Double szCs)
      Sets the font size of the text in complex script.

      Represents the following element tag in the schema: w:szCs.

      Parameters:
      szCs - the font size of the text in complex script.

    • getU

      org.openxmlformats.schemas.wordprocessingml.x2006.main.CTUnderline getU()
      Returns the underline style of the text.

      Represents the following element tag in the schema: w:u.

      Returns:
      the underline style of the text.

    • setU

      void setU(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTUnderline u)
      Sets the underline style of the text.

      Represents the following element tag in the schema: w:u.

      Parameters:
      u - the underline style of the text.

    • isVanish

      boolean isVanish()
      Returns whether the text is vanished.

      Represents the following element tag in the schema: w:vanish.

      Returns:
      whether the text is vanished.

    • setVanish

      void setVanish(boolean vanish)
      Sets whether the text is vanished.

      Represents the following element tag in the schema: w:vanish.

      Parameters:
      vanish - whether the text is vanished.

    • getVertAlign

      org.openxmlformats.schemas.officeDocument.x2006.sharedTypes.STVerticalAlignRun.Enum getVertAlign()
      Returns the vertical alignment.

      Represents the following element tag in the schema: w:vertAlign.

      Returns:
      the vertical alignment.

    • setVertAlign

      void setVertAlign(org.openxmlformats.schemas.officeDocument.x2006.sharedTypes.STVerticalAlignRun.Enum vertAlign)
      Sets the vertical alignment.

      Represents the following element tag in the schema: w:vertAlign.

      Parameters:
      vertAlign - the vertical alignment.

    • getW

      Integer getW()
      Returns the character scale.

      Represents the following element tag in the schema: w:w.

      Returns:
      the character scale.

    • setW

      void setW(Integer w)
      Sets the character scale.

      Represents the following element tag in the schema: w:w.

      Parameters:
      w - the character scale.

    • isWebHidden

      boolean isWebHidden()
      Returns whether the text is web hidden.

      Represents the following element tag in the schema: w:webHidden.

      Returns:
      whether the text is web hidden.

    • setWebHidden

      void setWebHidden(boolean webHidden)
      Sets whether the text is web hidden.

      Represents the following element tag in the schema: w:webHidden.

      Parameters:
      webHidden - whether the text is web hidden.