Package org.docx4j.wml

Class SdtPr

java.lang.Object

org.docx4j.wml.SdtPr

All Implemented Interfaces:

Child

public class SdtPr
extends Object
implements Child

Java class for CT_SdtPr complex type.

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

 <complexType name="CT_SdtPr">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <choice maxOccurs="unbounded">
         <element name="rPr" type="{http://schemas.openxmlformats.org/wordprocessingml/2006/main}CT_RPr" minOccurs="0"/>
         <element name="alias" minOccurs="0">
           <complexType>
             <complexContent>
               <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                 <attribute name="val" type="{http://www.w3.org/2001/XMLSchema}string" />
               </restriction>
             </complexContent>
           </complexType>
         </element>
         <element name="lock" type="{http://schemas.openxmlformats.org/wordprocessingml/2006/main}CT_Lock" minOccurs="0"/>
         <element name="placeholder" type="{http://schemas.openxmlformats.org/wordprocessingml/2006/main}CT_Placeholder" minOccurs="0"/>
         <element name="showingPlcHdr" type="{http://schemas.openxmlformats.org/wordprocessingml/2006/main}BooleanDefaultTrue" minOccurs="0"/>
         <element name="dataBinding" type="{http://schemas.openxmlformats.org/wordprocessingml/2006/main}CT_DataBinding" minOccurs="0"/>
         <element name="temporary" type="{http://schemas.openxmlformats.org/wordprocessingml/2006/main}BooleanDefaultTrue" minOccurs="0"/>
         <element ref="{http://schemas.openxmlformats.org/wordprocessingml/2006/main}id" minOccurs="0"/>
         <element ref="{http://schemas.openxmlformats.org/wordprocessingml/2006/main}tag" minOccurs="0"/>
         <choice minOccurs="0">
           <element name="equation">
             <complexType>
               <complexContent>
                 <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                 </restriction>
               </complexContent>
             </complexType>
           </element>
           <element name="comboBox" type="{http://schemas.openxmlformats.org/wordprocessingml/2006/main}CT_SdtComboBox"/>
           <element name="date" type="{http://schemas.openxmlformats.org/wordprocessingml/2006/main}CT_SdtDate"/>
           <element name="docPartObj" type="{http://schemas.openxmlformats.org/wordprocessingml/2006/main}CT_SdtDocPart"/>
           <element name="docPartList" type="{http://schemas.openxmlformats.org/wordprocessingml/2006/main}CT_SdtDocPart"/>
           <element name="dropDownList" type="{http://schemas.openxmlformats.org/wordprocessingml/2006/main}CT_SdtDropDownList"/>
           <element name="picture">
             <complexType>
               <complexContent>
                 <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                 </restriction>
               </complexContent>
             </complexType>
           </element>
           <element name="richText">
             <complexType>
               <complexContent>
                 <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                 </restriction>
               </complexContent>
             </complexType>
           </element>
           <element name="text" type="{http://schemas.openxmlformats.org/wordprocessingml/2006/main}CT_SdtText"/>
           <element name="citation">
             <complexType>
               <complexContent>
                 <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                 </restriction>
               </complexContent>
             </complexType>
           </element>
           <element name="group">
             <complexType>
               <complexContent>
                 <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                 </restriction>
               </complexContent>
             </complexType>
           </element>
           <element name="bibliography">
             <complexType>
               <complexContent>
                 <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                 </restriction>
               </complexContent>
             </complexType>
           </element>
         </choice>
         <element ref="{http://schemas.microsoft.com/office/word/2010/wordml}checkbox" minOccurs="0"/>
         <element ref="{http://schemas.microsoft.com/office/word/2010/wordml}entityPicker" minOccurs="0"/>
         <element ref="{http://schemas.microsoft.com/office/word/2012/wordml}appearance" minOccurs="0"/>
         <element ref="{http://schemas.microsoft.com/office/word/2012/wordml}color" minOccurs="0"/>
         <element ref="{http://schemas.microsoft.com/office/word/2012/wordml}dataBinding" minOccurs="0"/>
         <element ref="{http://schemas.microsoft.com/office/word/2012/wordml}repeatingSection" minOccurs="0"/>
         <element ref="{http://schemas.microsoft.com/office/word/2012/wordml}repeatingSectionItem" minOccurs="0"/>
         <element ref="{http://schemas.microsoft.com/office/word/2012/wordml}webExtensionCreated" minOccurs="0"/>
         <element ref="{http://schemas.microsoft.com/office/word/2012/wordml}webExtensionLinked" minOccurs="0"/>
       </choice>
     </restriction>
   </complexContent>
 </complexType>
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SdtPr.Alias	Java class for anonymous complex type.
static class	SdtPr.Bibliography	Java class for anonymous complex type.
static class	SdtPr.Citation	Java class for anonymous complex type.
static class	SdtPr.Equation	Java class for anonymous complex type.
static class	SdtPr.Group	Java class for anonymous complex type.
static class	SdtPr.Picture	Java class for anonymous complex type.
static class	SdtPr.RichText	Java class for anonymous complex type.

Field Summary

Fields

Modifier and Type	Field	Description
protected List<Object>	rPrOrAliasOrLock

Constructor Summary

Constructors

Constructor	Description
SdtPr()

Method Summary

Modifier and Type	Method	Description
void	afterUnmarshal(jakarta.xml.bind.Unmarshaller unmarshaller, Object parent)	This method is invoked by the JAXB implementation on each instance when unmarshalling completes.
Object	getByClass(Class clazz)	return the first object
CTDataBinding	getDataBinding()
Id	getId()	Gets the value of the id property.
Object	getParent()	Gets the parent object in the object tree representing the unmarshalled xml document.
List<Object>	getRPrOrAliasOrLock()	Gets the value of the rPrOrAliasOrLock property.
Tag	getTag()	Gets the value of the tag property.
void	setDataBinding(CTDataBinding value)
BigInteger	setId()
void	setId(Id value)	Sets the value of the id property.
void	setParent(Object parent)
void	setShowingPlcHdr(boolean set)
void	setTag(Tag value)	Sets the value of the tag property.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

rPrOrAliasOrLock

protected List<Object> rPrOrAliasOrLock

Constructor Details

SdtPr

public SdtPr()

Method Details

getRPrOrAliasOrLock

public List<Object> getRPrOrAliasOrLock()

Gets the value of the rPrOrAliasOrLock property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the rPrOrAliasOrLock property.

For example, to add a new item, do as follows:

    getRPrOrAliasOrLock().add(newItem);
 

Objects of the following type(s) are allowed in the list JAXBElement<CTPlaceholder> JAXBElement<CTDataBinding> JAXBElement<SdtPr.Alias> JAXBElement<CTSdtCheckbox> JAXBElement<BooleanDefaultTrue> JAXBElement<BooleanDefaultTrue> JAXBElement<CTSdtComboBox> JAXBElement<SdtPr.Citation> JAXBElement<CTDataBinding> JAXBElement<BooleanDefaultTrue> JAXBElement<CTEmpty> Tag JAXBElement<SdtPr.Bibliography> JAXBElement<CTEmpty> JAXBElement<CTLock> JAXBElement<CTSdtDocPart> Id JAXBElement<CTSdtText> JAXBElement<CTSdtDate> JAXBElement<CTColor> JAXBElement<SdtPr.Equation> JAXBElement<CTSdtDocPart> JAXBElement<BooleanDefaultTrue> JAXBElement<CTSdtAppearance> JAXBElement<CTSdtDropDownList> JAXBElement<SdtPr.Picture> JAXBElement<CTSdtRepeatedSection> JAXBElement<SdtPr.Group> JAXBElement<RPr> JAXBElement<SdtPr.RichText>

getId

public Id getId()

Gets the value of the id property.

Returns:

possible object is Id

setId

public void setId(Id value)

Sets the value of the id property.

Parameters:

value - allowed object is Id

setId

public BigInteger setId()

getByClass

public Object getByClass(Class clazz)

return the first object

Parameters:

clazz -

Returns:

Since:

3.0.1

getTag

public Tag getTag()

Gets the value of the tag property.

Returns:

possible object is SdtPr.Tag

setTag

public void setTag(Tag value)

Sets the value of the tag property.

Parameters:

value - allowed object is SdtPr.Tag

getDataBinding

public CTDataBinding getDataBinding()

setDataBinding

public void setDataBinding(CTDataBinding value)

setShowingPlcHdr

public void setShowingPlcHdr(boolean set)

Parameters:

set -

Since:

6.1.0

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.