CTFrame (docx4j-openxml-objects 8.1.1 API)

java.lang.Object
- org.docx4j.wml.CTFrame

All Implemented Interfaces:: Child

public class CTFrame
extends Object
implements Child

Java class for CT_Frame complex type.

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

 <complexType name="CT_Frame">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="sz" 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="name" 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="sourceFileName" type="{http://schemas.openxmlformats.org/wordprocessingml/2006/main}CT_Rel" minOccurs="0"/>
         <element name="marW" type="{http://schemas.openxmlformats.org/wordprocessingml/2006/main}CT_PixelsMeasure" minOccurs="0"/>
         <element name="marH" type="{http://schemas.openxmlformats.org/wordprocessingml/2006/main}CT_PixelsMeasure" minOccurs="0"/>
         <element name="scrollbar" type="{http://schemas.openxmlformats.org/wordprocessingml/2006/main}CT_FrameScrollbar" minOccurs="0"/>
         <element name="noResizeAllowed" type="{http://schemas.openxmlformats.org/wordprocessingml/2006/main}BooleanDefaultTrue" minOccurs="0"/>
         <element name="linkedToFile" type="{http://schemas.openxmlformats.org/wordprocessingml/2006/main}BooleanDefaultTrue" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CTFrame.Name
Java class for anonymous complex type.

static class CTFrame.Sz
Java class for anonymous complex type.

Nested Classes
Modifier and Type	Class and Description
`static class`	`CTFrame.Name` Java class for anonymous complex type.
`static class`	`CTFrame.Sz` Java class for anonymous complex type.

Field Summary

Fields
Modifier and Type	Field and Description
`protected BooleanDefaultTrue`	`linkedToFile`
`protected CTPixelsMeasure`	`marH`
`protected CTPixelsMeasure`	`marW`
`protected CTFrame.Name`	`name`
`protected BooleanDefaultTrue`	`noResizeAllowed`
`protected CTFrameScrollbar`	`scrollbar`
`protected CTRel`	`sourceFileName`
`protected CTFrame.Sz`	`sz`

Constructor Summary

Constructors
Constructor and Description

CTFrame()

Constructors
Constructor and Description
`CTFrame()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`afterUnmarshal(Unmarshaller unmarshaller, Object parent)` This method is invoked by the JAXB implementation on each instance when unmarshalling completes.
`BooleanDefaultTrue`	`getLinkedToFile()` Gets the value of the linkedToFile property.
`CTPixelsMeasure`	`getMarH()` Gets the value of the marH property.
`CTPixelsMeasure`	`getMarW()` Gets the value of the marW property.
`CTFrame.Name`	`getName()` Gets the value of the name property.
`BooleanDefaultTrue`	`getNoResizeAllowed()` Gets the value of the noResizeAllowed property.
`Object`	`getParent()` Gets the parent object in the object tree representing the unmarshalled xml document.
`CTFrameScrollbar`	`getScrollbar()` Gets the value of the scrollbar property.
`CTRel`	`getSourceFileName()` Gets the value of the sourceFileName property.
`CTFrame.Sz`	`getSz()` Gets the value of the sz property.
`void`	`setLinkedToFile(BooleanDefaultTrue value)` Sets the value of the linkedToFile property.
`void`	`setMarH(CTPixelsMeasure value)` Sets the value of the marH property.
`void`	`setMarW(CTPixelsMeasure value)` Sets the value of the marW property.
`void`	`setName(CTFrame.Name value)` Sets the value of the name property.
`void`	`setNoResizeAllowed(BooleanDefaultTrue value)` Sets the value of the noResizeAllowed property.
`void`	`setParent(Object parent)`
`void`	`setScrollbar(CTFrameScrollbar value)` Sets the value of the scrollbar property.
`void`	`setSourceFileName(CTRel value)` Sets the value of the sourceFileName property.
`void`	`setSz(CTFrame.Sz value)` Sets the value of the sz property.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - sz
```
protected CTFrame.Sz sz
```
  - name
```
protected CTFrame.Name name
```
  - sourceFileName
```
protected CTRel sourceFileName
```
  - marW
```
protected CTPixelsMeasure marW
```
  - marH
```
protected CTPixelsMeasure marH
```
  - scrollbar
```
protected CTFrameScrollbar scrollbar
```
  - noResizeAllowed
```
protected BooleanDefaultTrue noResizeAllowed
```
  - linkedToFile
```
protected BooleanDefaultTrue linkedToFile
```
- Constructor Detail
  - CTFrame
```
public CTFrame()
```
- Method Detail
  - getSz
```
public CTFrame.Sz getSz()
```
    Gets the value of the sz property.
    
    Returns:
    
    possible object is CTFrame.Sz
  - setSz
```
public void setSz(CTFrame.Sz value)
```
    Sets the value of the sz property.
    
    Parameters:
    
    value - allowed object is CTFrame.Sz
  - getName
```
public CTFrame.Name getName()
```
    Gets the value of the name property.
    
    Returns:
    
    possible object is CTFrame.Name
  - setName
```
public void setName(CTFrame.Name value)
```
    Sets the value of the name property.
    
    Parameters:
    
    value - allowed object is CTFrame.Name
  - getSourceFileName
```
public CTRel getSourceFileName()
```
    Gets the value of the sourceFileName property.
    
    Returns:
    
    possible object is CTRel
  - setSourceFileName
```
public void setSourceFileName(CTRel value)
```
    Sets the value of the sourceFileName property.
    
    Parameters:
    
    value - allowed object is CTRel
  - getMarW
```
public CTPixelsMeasure getMarW()
```
    Gets the value of the marW property.
    
    Returns:
    
    possible object is CTPixelsMeasure
  - setMarW
```
public void setMarW(CTPixelsMeasure value)
```
    Sets the value of the marW property.
    
    Parameters:
    
    value - allowed object is CTPixelsMeasure
  - getMarH
```
public CTPixelsMeasure getMarH()
```
    Gets the value of the marH property.
    
    Returns:
    
    possible object is CTPixelsMeasure
  - setMarH
```
public void setMarH(CTPixelsMeasure value)
```
    Sets the value of the marH property.
    
    Parameters:
    
    value - allowed object is CTPixelsMeasure
  - getScrollbar
```
public CTFrameScrollbar getScrollbar()
```
    Gets the value of the scrollbar property.
    
    Returns:
    
    possible object is CTFrameScrollbar
  - setScrollbar
```
public void setScrollbar(CTFrameScrollbar value)
```
    Sets the value of the scrollbar property.
    
    Parameters:
    
    value - allowed object is CTFrameScrollbar
  - getNoResizeAllowed
```
public BooleanDefaultTrue getNoResizeAllowed()
```
    Gets the value of the noResizeAllowed property.
    
    Returns:
    
    possible object is BooleanDefaultTrue
  - setNoResizeAllowed
```
public void setNoResizeAllowed(BooleanDefaultTrue value)
```
    Sets the value of the noResizeAllowed property.
    
    Parameters:
    
    value - allowed object is BooleanDefaultTrue
  - getLinkedToFile
```
public BooleanDefaultTrue getLinkedToFile()
```
    Gets the value of the linkedToFile property.
    
    Returns:
    
    possible object is BooleanDefaultTrue
  - setLinkedToFile
```
public void setLinkedToFile(BooleanDefaultTrue value)
```
    Sets the value of the linkedToFile property.
    
    Parameters:
    
    value - allowed object is BooleanDefaultTrue
  - 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(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.

Class CTFrame

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

sz

name

sourceFileName

marW

marH

scrollbar

noResizeAllowed

linkedToFile

Constructor Detail

CTFrame

Method Detail

getSz

setSz

getName

setName

getSourceFileName

setSourceFileName

getMarW

setMarW

getMarH

setMarH

getScrollbar

setScrollbar

getNoResizeAllowed

setNoResizeAllowed

getLinkedToFile

setLinkedToFile

getParent

setParent

afterUnmarshal