LayoutPreparationParams (CIP4 xJdfLib 0.4 API)

java.lang.Object
- org.cip4.lib.xjdf.schema.ParameterType
- - org.cip4.lib.xjdf.schema.LayoutPreparationParams

All Implemented Interfaces:: Serializable

public class LayoutPreparationParams
extends ParameterType
implements Serializable

Java class for LayoutPreparationParams complex type.

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

 <complexType name="LayoutPreparationParams">
   <complexContent>
     <extension base="{http://www.CIP4.org/JDFSchema_2_0}ParameterType">
       <sequence>
         <element ref="{http://www.CIP4.org/JDFSchema_2_0}FitPolicy" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{http://www.CIP4.org/JDFSchema_2_0}InsertSheet" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{http://www.CIP4.org/JDFSchema_2_0}PageCell" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{http://www.CIP4.org/JDFSchema_2_0}JobField" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{http://www.CIP4.org/JDFSchema_2_0}DeviceMark" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{http://www.CIP4.org/JDFSchema_2_0}ImageShift" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attribute name="FinishingOrder" type="{http://www.w3.org/2001/XMLSchema}anySimpleType" />
       <attribute name="ImplicitGutterMinimumLimit" type="{http://www.CIP4.org/JDFSchema_2_0}XYPair" />
       <attribute name="GutterMinimumLimit" type="{http://www.CIP4.org/JDFSchema_2_0}XYPair" />
       <attribute name="HorizontalCreep" type="{http://www.CIP4.org/JDFSchema_2_0}IntegerList" />
       <attribute name="PresentationDirection" type="{http://www.CIP4.org/JDFSchema_2_0}Any" />
       <attribute name="Rotate" type="{http://www.w3.org/2001/XMLSchema}anySimpleType" />
       <attribute name="ImplicitGutter" type="{http://www.CIP4.org/JDFSchema_2_0}XYPair" />
       <attribute name="StackDepth" type="{http://www.CIP4.org/JDFSchema_2_0}integer" />
       <attribute name="NumberUp" type="{http://www.CIP4.org/JDFSchema_2_0}XYPair" />
       <attribute name="Gutter" type="{http://www.CIP4.org/JDFSchema_2_0}XYPair" />
       <attribute name="StepRepeat" type="{http://www.CIP4.org/JDFSchema_2_0}string" />
       <attribute name="StepDocs" type="{http://www.CIP4.org/JDFSchema_2_0}XYPair" />
       <attribute name="BindingEdge" type="{http://www.w3.org/2001/XMLSchema}anySimpleType" />
       <attribute name="FoldCatalogOrientation" type="{http://www.w3.org/2001/XMLSchema}anySimpleType" />
       <attribute name="FoldCatalog" type="{http://www.CIP4.org/JDFSchema_2_0}string" />
       <attribute name="BackMarkList" type="{http://www.CIP4.org/JDFSchema_2_0}NMTOKENS" />
       <attribute name="SurfaceContentsBox" type="{http://www.CIP4.org/JDFSchema_2_0}rectangle" />
       <attribute name="PageOrder" type="{http://www.CIP4.org/JDFSchema_2_0}NMTOKEN" />
       <attribute name="FrontMarkList" type="{http://www.CIP4.org/JDFSchema_2_0}NMTOKENS" />
       <attribute name="VerticalCreep" type="{http://www.CIP4.org/JDFSchema_2_0}IntegerList" />
       <attribute name="CreepValue" type="{http://www.CIP4.org/JDFSchema_2_0}XYPair" />
       <attribute name="Sides" type="{http://www.w3.org/2001/XMLSchema}anySimpleType" />
       <attribute name="PageDistributionScheme" type="{http://www.CIP4.org/JDFSchema_2_0}NMTOKEN" />
       <attribute name="MediaRef" type="{http://www.CIP4.org/JDFSchema_2_0}IDREF" />
       <attribute name="ExternalImpositionTemplateRef" type="{http://www.CIP4.org/JDFSchema_2_0}IDREF" />
     </extension>
   </complexContent>
 </complexType>

See Also:: Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<String>`	`backMarkList`
`protected String`	`bindingEdge`
`protected XYPair`	`creepValue`
`protected List<DeviceMark>`	`deviceMark`
`protected Object`	`externalImpositionTemplateRef`
`protected String`	`finishingOrder`
`protected List<FitPolicy>`	`fitPolicy`
`protected String`	`foldCatalog`
`protected String`	`foldCatalogOrientation`
`protected List<String>`	`frontMarkList`
`protected XYPair`	`gutter`
`protected XYPair`	`gutterMinimumLimit`
`protected IntegerList`	`horizontalCreep`
`protected List<ImageShift>`	`imageShift`
`protected XYPair`	`implicitGutter`
`protected XYPair`	`implicitGutterMinimumLimit`
`protected List<InsertSheet>`	`insertSheet`
`protected List<JobField>`	`jobField`
`protected Object`	`mediaRef`
`protected XYPair`	`numberUp`
`protected List<PageCell>`	`pageCell`
`protected String`	`pageDistributionScheme`
`protected String`	`pageOrder`
`protected String`	`presentationDirection`
`protected String`	`rotate`
`protected String`	`sides`
`protected Integer`	`stackDepth`
`protected XYPair`	`stepDocs`
`protected String`	`stepRepeat`
`protected Rectangle`	`surfaceContentsBox`
`protected IntegerList`	`verticalCreep`

Constructor Summary

Constructors
Constructor and Description

LayoutPreparationParams()

Constructors
Constructor and Description
`LayoutPreparationParams()`

Method Summary

Methods
Modifier and Type	Method and Description
`List<String>`	`getBackMarkList()` Gets the value of the backMarkList property.
`String`	`getBindingEdge()` Gets the value of the bindingEdge property.
`XYPair`	`getCreepValue()` Gets the value of the creepValue property.
`List<DeviceMark>`	`getDeviceMark()` Gets the value of the deviceMark property.
`Object`	`getExternalImpositionTemplateRef()` Gets the value of the externalImpositionTemplateRef property.
`String`	`getFinishingOrder()` Gets the value of the finishingOrder property.
`List<FitPolicy>`	`getFitPolicy()` Gets the value of the fitPolicy property.
`String`	`getFoldCatalog()` Gets the value of the foldCatalog property.
`String`	`getFoldCatalogOrientation()` Gets the value of the foldCatalogOrientation property.
`List<String>`	`getFrontMarkList()` Gets the value of the frontMarkList property.
`XYPair`	`getGutter()` Gets the value of the gutter property.
`XYPair`	`getGutterMinimumLimit()` Gets the value of the gutterMinimumLimit property.
`IntegerList`	`getHorizontalCreep()` Gets the value of the horizontalCreep property.
`List<ImageShift>`	`getImageShift()` Gets the value of the imageShift property.
`XYPair`	`getImplicitGutter()` Gets the value of the implicitGutter property.
`XYPair`	`getImplicitGutterMinimumLimit()` Gets the value of the implicitGutterMinimumLimit property.
`List<InsertSheet>`	`getInsertSheet()` Gets the value of the insertSheet property.
`List<JobField>`	`getJobField()` Gets the value of the jobField property.
`Object`	`getMediaRef()` Gets the value of the mediaRef property.
`XYPair`	`getNumberUp()` Gets the value of the numberUp property.
`List<PageCell>`	`getPageCell()` Gets the value of the pageCell property.
`String`	`getPageDistributionScheme()` Gets the value of the pageDistributionScheme property.
`String`	`getPageOrder()` Gets the value of the pageOrder property.
`String`	`getPresentationDirection()` Gets the value of the presentationDirection property.
`String`	`getRotate()` Gets the value of the rotate property.
`String`	`getSides()` Gets the value of the sides property.
`Integer`	`getStackDepth()` Gets the value of the stackDepth property.
`XYPair`	`getStepDocs()` Gets the value of the stepDocs property.
`String`	`getStepRepeat()` Gets the value of the stepRepeat property.
`Rectangle`	`getSurfaceContentsBox()` Gets the value of the surfaceContentsBox property.
`IntegerList`	`getVerticalCreep()` Gets the value of the verticalCreep property.
`void`	`setBindingEdge(String value)` Sets the value of the bindingEdge property.
`void`	`setCreepValue(XYPair value)` Sets the value of the creepValue property.
`void`	`setExternalImpositionTemplateRef(Object value)` Sets the value of the externalImpositionTemplateRef property.
`void`	`setFinishingOrder(String value)` Sets the value of the finishingOrder property.
`void`	`setFoldCatalog(String value)` Sets the value of the foldCatalog property.
`void`	`setFoldCatalogOrientation(String value)` Sets the value of the foldCatalogOrientation property.
`void`	`setGutter(XYPair value)` Sets the value of the gutter property.
`void`	`setGutterMinimumLimit(XYPair value)` Sets the value of the gutterMinimumLimit property.
`void`	`setHorizontalCreep(IntegerList value)` Sets the value of the horizontalCreep property.
`void`	`setImplicitGutter(XYPair value)` Sets the value of the implicitGutter property.
`void`	`setImplicitGutterMinimumLimit(XYPair value)` Sets the value of the implicitGutterMinimumLimit property.
`void`	`setMediaRef(Object value)` Sets the value of the mediaRef property.
`void`	`setNumberUp(XYPair value)` Sets the value of the numberUp property.
`void`	`setPageDistributionScheme(String value)` Sets the value of the pageDistributionScheme property.
`void`	`setPageOrder(String value)` Sets the value of the pageOrder property.
`void`	`setPresentationDirection(String value)` Sets the value of the presentationDirection property.
`void`	`setRotate(String value)` Sets the value of the rotate property.
`void`	`setSides(String value)` Sets the value of the sides property.
`void`	`setStackDepth(Integer value)` Sets the value of the stackDepth property.
`void`	`setStepDocs(XYPair value)` Sets the value of the stepDocs property.
`void`	`setStepRepeat(String value)` Sets the value of the stepRepeat property.
`void`	`setSurfaceContentsBox(Rectangle value)` Sets the value of the surfaceContentsBox property.
`void`	`setVerticalCreep(IntegerList value)` Sets the value of the verticalCreep property.

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

- Field Detail
  - fitPolicy
```
protected List<FitPolicy> fitPolicy
```
  - insertSheet
```
protected List<InsertSheet> insertSheet
```
  - pageCell
```
protected List<PageCell> pageCell
```
  - jobField
```
protected List<JobField> jobField
```
  - deviceMark
```
protected List<DeviceMark> deviceMark
```
  - imageShift
```
protected List<ImageShift> imageShift
```
  - finishingOrder
```
protected String finishingOrder
```
  - implicitGutterMinimumLimit
```
protected XYPair implicitGutterMinimumLimit
```
  - gutterMinimumLimit
```
protected XYPair gutterMinimumLimit
```
  - horizontalCreep
```
protected IntegerList horizontalCreep
```
  - presentationDirection
```
protected String presentationDirection
```
  - rotate
```
protected String rotate
```
  - implicitGutter
```
protected XYPair implicitGutter
```
  - stackDepth
```
protected Integer stackDepth
```
  - numberUp
```
protected XYPair numberUp
```
  - gutter
```
protected XYPair gutter
```
  - stepRepeat
```
protected String stepRepeat
```
  - stepDocs
```
protected XYPair stepDocs
```
  - bindingEdge
```
protected String bindingEdge
```
  - foldCatalogOrientation
```
protected String foldCatalogOrientation
```
  - foldCatalog
```
protected String foldCatalog
```
  - backMarkList
```
protected List<String> backMarkList
```
  - surfaceContentsBox
```
protected Rectangle surfaceContentsBox
```
  - pageOrder
```
protected String pageOrder
```
  - frontMarkList
```
protected List<String> frontMarkList
```
  - verticalCreep
```
protected IntegerList verticalCreep
```
  - creepValue
```
protected XYPair creepValue
```
  - sides
```
protected String sides
```
  - pageDistributionScheme
```
protected String pageDistributionScheme
```
  - mediaRef
```
protected Object mediaRef
```
  - externalImpositionTemplateRef
```
protected Object externalImpositionTemplateRef
```
- Constructor Detail
  - LayoutPreparationParams
```
public LayoutPreparationParams()
```
- Method Detail
  - getFitPolicy
```
public List<FitPolicy> getFitPolicy()
```
    Gets the value of the fitPolicy 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 fitPolicy property.
    For example, to add a new item, do as follows:
```
    getFitPolicy().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list FitPolicy
  - getInsertSheet
```
public List<InsertSheet> getInsertSheet()
```
    Gets the value of the insertSheet 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 insertSheet property.
    For example, to add a new item, do as follows:
```
    getInsertSheet().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list InsertSheet
  - getPageCell
```
public List<PageCell> getPageCell()
```
    Gets the value of the pageCell 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 pageCell property.
    For example, to add a new item, do as follows:
```
    getPageCell().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list PageCell
  - getJobField
```
public List<JobField> getJobField()
```
    Gets the value of the jobField 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 jobField property.
    For example, to add a new item, do as follows:
```
    getJobField().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list JobField
  - getDeviceMark
```
public List<DeviceMark> getDeviceMark()
```
    Gets the value of the deviceMark 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 deviceMark property.
    For example, to add a new item, do as follows:
```
    getDeviceMark().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list DeviceMark
  - getImageShift
```
public List<ImageShift> getImageShift()
```
    Gets the value of the imageShift 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 imageShift property.
    For example, to add a new item, do as follows:
```
    getImageShift().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list ImageShift
  - getFinishingOrder
```
public String getFinishingOrder()
```
    Gets the value of the finishingOrder property.
    
    Returns:
    possible object is String
  - setFinishingOrder
```
public void setFinishingOrder(String value)
```
    Sets the value of the finishingOrder property.
    
    Parameters:
    value - allowed object is String
  - getImplicitGutterMinimumLimit
```
public XYPair getImplicitGutterMinimumLimit()
```
    Gets the value of the implicitGutterMinimumLimit property.
    
    Returns:
    possible object is String
  - setImplicitGutterMinimumLimit
```
public void setImplicitGutterMinimumLimit(XYPair value)
```
    Sets the value of the implicitGutterMinimumLimit property.
    
    Parameters:
    value - allowed object is String
  - getGutterMinimumLimit
```
public XYPair getGutterMinimumLimit()
```
    Gets the value of the gutterMinimumLimit property.
    
    Returns:
    possible object is String
  - setGutterMinimumLimit
```
public void setGutterMinimumLimit(XYPair value)
```
    Sets the value of the gutterMinimumLimit property.
    
    Parameters:
    value - allowed object is String
  - getHorizontalCreep
```
public IntegerList getHorizontalCreep()
```
    Gets the value of the horizontalCreep property.
    
    Returns:
    possible object is String
  - setHorizontalCreep
```
public void setHorizontalCreep(IntegerList value)
```
    Sets the value of the horizontalCreep property.
    
    Parameters:
    value - allowed object is String
  - getPresentationDirection
```
public String getPresentationDirection()
```
    Gets the value of the presentationDirection property.
    
    Returns:
    possible object is String
  - setPresentationDirection
```
public void setPresentationDirection(String value)
```
    Sets the value of the presentationDirection property.
    
    Parameters:
    value - allowed object is String
  - getRotate
```
public String getRotate()
```
    Gets the value of the rotate property.
    
    Returns:
    possible object is String
  - setRotate
```
public void setRotate(String value)
```
    Sets the value of the rotate property.
    
    Parameters:
    value - allowed object is String
  - getImplicitGutter
```
public XYPair getImplicitGutter()
```
    Gets the value of the implicitGutter property.
    
    Returns:
    possible object is String
  - setImplicitGutter
```
public void setImplicitGutter(XYPair value)
```
    Sets the value of the implicitGutter property.
    
    Parameters:
    value - allowed object is String
  - getStackDepth
```
public Integer getStackDepth()
```
    Gets the value of the stackDepth property.
    
    Returns:
    possible object is Integer
  - setStackDepth
```
public void setStackDepth(Integer value)
```
    Sets the value of the stackDepth property.
    
    Parameters:
    value - allowed object is Integer
  - getNumberUp
```
public XYPair getNumberUp()
```
    Gets the value of the numberUp property.
    
    Returns:
    possible object is String
  - setNumberUp
```
public void setNumberUp(XYPair value)
```
    Sets the value of the numberUp property.
    
    Parameters:
    value - allowed object is String
  - getGutter
```
public XYPair getGutter()
```
    Gets the value of the gutter property.
    
    Returns:
    possible object is String
  - setGutter
```
public void setGutter(XYPair value)
```
    Sets the value of the gutter property.
    
    Parameters:
    value - allowed object is String
  - getStepRepeat
```
public String getStepRepeat()
```
    Gets the value of the stepRepeat property.
    
    Returns:
    possible object is String
  - setStepRepeat
```
public void setStepRepeat(String value)
```
    Sets the value of the stepRepeat property.
    
    Parameters:
    value - allowed object is String
  - getStepDocs
```
public XYPair getStepDocs()
```
    Gets the value of the stepDocs property.
    
    Returns:
    possible object is String
  - setStepDocs
```
public void setStepDocs(XYPair value)
```
    Sets the value of the stepDocs property.
    
    Parameters:
    value - allowed object is String
  - getBindingEdge
```
public String getBindingEdge()
```
    Gets the value of the bindingEdge property.
    
    Returns:
    possible object is String
  - setBindingEdge
```
public void setBindingEdge(String value)
```
    Sets the value of the bindingEdge property.
    
    Parameters:
    value - allowed object is String
  - getFoldCatalogOrientation
```
public String getFoldCatalogOrientation()
```
    Gets the value of the foldCatalogOrientation property.
    
    Returns:
    possible object is String
  - setFoldCatalogOrientation
```
public void setFoldCatalogOrientation(String value)
```
    Sets the value of the foldCatalogOrientation property.
    
    Parameters:
    value - allowed object is String
  - getFoldCatalog
```
public String getFoldCatalog()
```
    Gets the value of the foldCatalog property.
    
    Returns:
    possible object is String
  - setFoldCatalog
```
public void setFoldCatalog(String value)
```
    Sets the value of the foldCatalog property.
    
    Parameters:
    value - allowed object is String
  - getBackMarkList
```
public List<String> getBackMarkList()
```
    Gets the value of the backMarkList 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 backMarkList property.
    For example, to add a new item, do as follows:
```
    getBackMarkList().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list String
  - getSurfaceContentsBox
```
public Rectangle getSurfaceContentsBox()
```
    Gets the value of the surfaceContentsBox property.
    
    Returns:
    possible object is String
  - setSurfaceContentsBox
```
public void setSurfaceContentsBox(Rectangle value)
```
    Sets the value of the surfaceContentsBox property.
    
    Parameters:
    value - allowed object is String
  - getPageOrder
```
public String getPageOrder()
```
    Gets the value of the pageOrder property.
    
    Returns:
    possible object is String
  - setPageOrder
```
public void setPageOrder(String value)
```
    Sets the value of the pageOrder property.
    
    Parameters:
    value - allowed object is String
  - getFrontMarkList
```
public List<String> getFrontMarkList()
```
    Gets the value of the frontMarkList 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 frontMarkList property.
    For example, to add a new item, do as follows:
```
    getFrontMarkList().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list String
  - getVerticalCreep
```
public IntegerList getVerticalCreep()
```
    Gets the value of the verticalCreep property.
    
    Returns:
    possible object is String
  - setVerticalCreep
```
public void setVerticalCreep(IntegerList value)
```
    Sets the value of the verticalCreep property.
    
    Parameters:
    value - allowed object is String
  - getCreepValue
```
public XYPair getCreepValue()
```
    Gets the value of the creepValue property.
    
    Returns:
    possible object is String
  - setCreepValue
```
public void setCreepValue(XYPair value)
```
    Sets the value of the creepValue property.
    
    Parameters:
    value - allowed object is String
  - getSides
```
public String getSides()
```
    Gets the value of the sides property.
    
    Returns:
    possible object is String
  - setSides
```
public void setSides(String value)
```
    Sets the value of the sides property.
    
    Parameters:
    value - allowed object is String
  - getPageDistributionScheme
```
public String getPageDistributionScheme()
```
    Gets the value of the pageDistributionScheme property.
    
    Returns:
    possible object is String
  - setPageDistributionScheme
```
public void setPageDistributionScheme(String value)
```
    Sets the value of the pageDistributionScheme property.
    
    Parameters:
    value - allowed object is String
  - getMediaRef
```
public Object getMediaRef()
```
    Gets the value of the mediaRef property.
    
    Returns:
    possible object is Object
  - setMediaRef
```
public void setMediaRef(Object value)
```
    Sets the value of the mediaRef property.
    
    Parameters:
    value - allowed object is Object
  - getExternalImpositionTemplateRef
```
public Object getExternalImpositionTemplateRef()
```
    Gets the value of the externalImpositionTemplateRef property.
    
    Returns:
    possible object is Object
  - setExternalImpositionTemplateRef
```
public void setExternalImpositionTemplateRef(Object value)
```
    Sets the value of the externalImpositionTemplateRef property.
    
    Parameters:
    value - allowed object is Object

Class LayoutPreparationParams

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

fitPolicy

insertSheet

pageCell

jobField

deviceMark

imageShift

finishingOrder

implicitGutterMinimumLimit

gutterMinimumLimit

horizontalCreep

presentationDirection

rotate

implicitGutter

stackDepth

numberUp

gutter

stepRepeat

stepDocs

bindingEdge

foldCatalogOrientation

foldCatalog

backMarkList

surfaceContentsBox

pageOrder

frontMarkList

verticalCreep

creepValue

sides

pageDistributionScheme

mediaRef

externalImpositionTemplateRef

Constructor Detail

LayoutPreparationParams

Method Detail

getFitPolicy

getInsertSheet

getPageCell

getJobField

getDeviceMark

getImageShift

getFinishingOrder

setFinishingOrder

getImplicitGutterMinimumLimit

setImplicitGutterMinimumLimit

getGutterMinimumLimit

setGutterMinimumLimit

getHorizontalCreep

setHorizontalCreep

getPresentationDirection

setPresentationDirection

getRotate

setRotate

getImplicitGutter

setImplicitGutter

getStackDepth

setStackDepth

getNumberUp

setNumberUp

getGutter

setGutter

getStepRepeat

setStepRepeat

getStepDocs

setStepDocs

getBindingEdge

setBindingEdge

getFoldCatalogOrientation

setFoldCatalogOrientation

getFoldCatalog

setFoldCatalog

getBackMarkList

getSurfaceContentsBox

setSurfaceContentsBox

getPageOrder