Package org.docx4j.wml

Class CTCaption

java.lang.Object
org.docx4j.wml.CTCaption
All Implemented Interfaces:
Child
public class CTCaption extends Object implements Child

Java class for CT_Caption complex type.

The following schema fragment specifies the expected content contained within this class. 

 <complexType name="CT_Caption">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <attribute name="name" use="required" type="{http://schemas.openxmlformats.org/wordprocessingml/2006/main}ST_String" />
       <attribute name="pos" type="{http://schemas.openxmlformats.org/wordprocessingml/2006/main}ST_CaptionPos" />
       <attribute name="chapNum" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
       <attribute name="heading" type="{http://schemas.openxmlformats.org/wordprocessingml/2006/main}ST_DecimalNumber" />
       <attribute name="noLabel" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
       <attribute name="numFmt" type="{http://schemas.openxmlformats.org/wordprocessingml/2006/main}NumberFormat" />
       <attribute name="sep" type="{http://schemas.openxmlformats.org/wordprocessingml/2006/main}ST_ChapterSep" />
     </restriction>
   </complexContent>
 </complexType>

  • Field Details

  • Constructor Details

    • CTCaption

      public CTCaption()

  • Method Details

    • getName

      public String getName()
      Gets the value of the name property.
      Returns:
      possible object is String

    • setName

      public void setName(String value)
      Sets the value of the name property.
      Parameters:
      value - allowed object is String

    • getPos

      public STCaptionPos getPos()
      Gets the value of the pos property.
      Returns:
      possible object is STCaptionPos

    • setPos

      public void setPos(STCaptionPos value)
      Sets the value of the pos property.
      Parameters:
      value - allowed object is STCaptionPos

    • isChapNum

      public boolean isChapNum()
      Gets the value of the chapNum property.
      Returns:
      possible object is Boolean

    • setChapNum

      public void setChapNum(Boolean value)
      Sets the value of the chapNum property.
      Parameters:
      value - allowed object is Boolean

    • getHeading

      public BigInteger getHeading()
      Gets the value of the heading property.
      Returns:
      possible object is BigInteger

    • setHeading

      public void setHeading(BigInteger value)
      Sets the value of the heading property.
      Parameters:
      value - allowed object is BigInteger

    • isNoLabel

      public boolean isNoLabel()
      Gets the value of the noLabel property.
      Returns:
      possible object is Boolean

    • setNoLabel

      public void setNoLabel(Boolean value)
      Sets the value of the noLabel property.
      Parameters:
      value - allowed object is Boolean

    • getNumFmt

      public NumberFormat getNumFmt()
      Gets the value of the numFmt property.
      Returns:
      possible object is NumberFormat

    • setNumFmt

      public void setNumFmt(NumberFormat value)
      Sets the value of the numFmt property.
      Parameters:
      value - allowed object is NumberFormat

    • getSep

      public STChapterSep getSep()
      Gets the value of the sep property.
      Returns:
      possible object is STChapterSep

    • setSep

      public void setSep(STChapterSep value)
      Sets the value of the sep property.
      Parameters:
      value - allowed object is STChapterSep

    • getParent

      public Object getParent()
      Gets the parent object in the object tree representing the unmarshalled xml document.
      Specified by:
      getParent in interface Child
      Returns:
      The parent object.

    • setParent

      public void setParent(Object parent)
      Specified by:
      setParent in interface Child

    • afterUnmarshal

      public void afterUnmarshal(jakarta.xml.bind.Unmarshaller unmarshaller, Object parent)
      This method is invoked by the JAXB implementation on each instance when unmarshalling completes.
      Parameters:
      parent - The parent object in the object tree.
      unmarshaller - The unmarshaller that generated the instance.