Class CometTemplate

All Implemented Interfaces:
Serializable
Direct Known Subclasses:
CometSnippet, CometTableTemplate

Java class for the Template configuration type

.
See Also:
  • Constructor Details

    • CometTemplate

      public CometTemplate()
      Instantiates a new comet template.
    • CometTemplate

      public CometTemplate(int id)
      Instantiates a new comet template.
      Parameters:
      id - the id
  • Method Details

    • getPageBreakEnum

      public static CometTemplate.PageBreak getPageBreakEnum(int externValue)
      Gets the page break enum.
      Parameters:
      externValue - the extern value
      Returns:
      the page break enum
    • checkMinimalConstraints

      public void checkMinimalConstraints() throws CometException
      Check minimal constraints.
      Overrides:
      checkMinimalConstraints in class CometEntity
      Throws:
      CometException - the comet exception
    • getActive

      public Boolean getActive()
      Gets the active.
      Returns:
      the active
    • getVisibility

      public CometTemplate.Visibility getVisibility()
      Gets the visibility.
      Returns:
      the visibility
    • getBottomPos

      public Double getBottomPos()
      Gets the bottom pos.
      Returns:
      the bottom pos
    • getBuildSupportScript

      public CometBuildSupportScript getBuildSupportScript()
      Gets the builds the support script.
      Returns:
      the builds the support script
    • getBuildSupportScriptId

      public Integer getBuildSupportScriptId()
      Gets the builds the support script id.
      Returns:
      the builds the support script id
    • getHasShapes

      public Boolean getHasShapes()
      Gets the checks for shapes.
      Returns:
      the checks for shapes
    • setHasShapes

      public void setHasShapes(Boolean hasShapes)
      Sets the checks for shapes.
      Parameters:
      hasShapes - the new checks for shapes
    • getColorId

      public Integer getColorId()
      Gets the color id.
      Returns:
      the color id
    • getRealWidth

      public Double getRealWidth()
      Gets the real width.
      Returns:
      the real width
    • setRealWidth

      public void setRealWidth(Double realWidth)
      Sets the real width.
      Parameters:
      realWidth - the new real width
    • getRealHeight

      public Double getRealHeight()
      Gets the real height.
      Returns:
      the real height
    • setRealHeight

      public void setRealHeight(Double realHeight)
      Sets the real height.
      Parameters:
      realHeight - the new real height
    • getDescription

      @CometDescription public String getDescription()
      Gets the description.
      Returns:
      the description
    • getEntityId

      public String getEntityId()
      Gets the entity id.
      Returns:
      the entity id
    • getFormat

      public Integer getFormat()
      Gets the format.
      Returns:
      the format
    • getLabel

      public String getLabel()
      Gets the label.
      Returns:
      the label
    • getLeftPos

      public Double getLeftPos()
      Gets the left pos.
      Returns:
      the left pos
    • getMagnets

      public Boolean getMagnets()
      Gets the magnets.
      Returns:
      the magnets
    • getMemberships

      public String getMemberships()
      Gets the memberships.
      Returns:
      the memberships
    • getMirrored

      public Boolean getMirrored()
      Gets the mirrored.
      Returns:
      the mirrored
    • getRecord

      public CometTemplate.Record getRecord()
      Gets the record.
      Returns:
      the record
    • getRepositoryFilename

      public String getRepositoryFilename() throws CometException
      Gets the repository filename.
      Overrides:
      getRepositoryFilename in class CometEntity
      Returns:
      the repository filename
      Throws:
      CometException - the comet exception
    • getRepositoryPath

      public String getRepositoryPath() throws CometException
      Gets the repository path.
      Overrides:
      getRepositoryPath in class CometEntity
      Returns:
      the repository path
      Throws:
      CometException - the comet exception
    • getRightPos

      public Double getRightPos()
      Gets the right pos.
      Returns:
      the right pos
    • getSpread

      public CometTemplate.Spread getSpread()
      Gets the spread.
      Returns:
      the spread
    • getStateId

      public Integer getStateId()
      Gets the state id.
      Returns:
      the state id
    • getTextflowPrefix1

      public String getTextflowPrefix1()
      Gets the textflow prefix 1.
      Returns:
      the textflow prefix 1
    • getTextflowPrefix1Script

      public CometTemplateTextPrefixScript getTextflowPrefix1Script()
      Gets the textflow prefix 1 script.
      Returns:
      the textflow prefix 1 script
    • getTextflowPrefix1ScriptId

      public Integer getTextflowPrefix1ScriptId()
      Gets the textflow prefix 1 script id.
      Returns:
      the textflow prefix 1 script id
    • getTextflowPrefixN

      public String getTextflowPrefixN()
      Gets the textflow prefix N.
      Returns:
      the textflow prefix N
    • getTextflowPrefixNScript

      public CometTemplateTextPrefixScript getTextflowPrefixNScript()
      Gets the textflow prefix N script.
      Returns:
      the textflow prefix N script
    • getTextflowPrefixNScriptId

      public Integer getTextflowPrefixNScriptId()
      Gets the textflow prefix N script id.
      Returns:
      the textflow prefix N script id
    • getTopPos

      public Double getTopPos()
      Gets the top pos.
      Returns:
      the top pos
    • getTypeId

      public Integer getTypeId()
      Gets the type id.
      Returns:
      the type id
    • setActive

      public void setActive(Boolean active)
      Sets the active.
      Parameters:
      active - the new active
    • setVisibility

      public void setVisibility(CometTemplate.Visibility visibility)
      Sets the visibility.
      Parameters:
      visibility - the new visibility
    • setBottomPos

      public void setBottomPos(Double bottomPos)
      Sets the bottom pos.
      Parameters:
      bottomPos - the new bottom pos
    • setBuildSupportScript

      public void setBuildSupportScript(CometBuildSupportScript buildSupportScript)
      Sets the builds the support script.
      Parameters:
      buildSupportScript - the new builds the support script
    • setBuildSupportScriptId

      public void setBuildSupportScriptId(Integer buildSupportScriptId)
      Sets the builds the support script id.
      Parameters:
      buildSupportScriptId - the new builds the support script id
    • setColorId

      public void setColorId(Integer colorId)
      Sets the color id.
      Parameters:
      colorId - the new color id
    • setDescription

      public void setDescription(String description)
      Sets the description.
      Parameters:
      description - the new description
    • setEntityId

      public void setEntityId(String entityId)
      Sets the entity id.
      Parameters:
      entityId - the new entity id
    • setFormat

      public void setFormat(Integer format)
      Sets the format.
      Parameters:
      format - the new format
    • setLabel

      public void setLabel(String label)
      Sets the label.
      Parameters:
      label - the new label
    • setLeftPos

      public void setLeftPos(Double leftPos)
      Sets the left pos.
      Parameters:
      leftPos - the new left pos
    • setMagnets

      public void setMagnets(Boolean magnets)
      Sets the magnets.
      Parameters:
      magnets - the new magnets
    • setMemberships

      public void setMemberships(String memberships)
      Sets the memberships.
      Parameters:
      memberships - the new memberships
    • setMirrored

      public void setMirrored(Boolean mirrored)
      Sets the mirrored.
      Parameters:
      mirrored - the new mirrored
    • setRecord

      public void setRecord(CometTemplate.Record record)
      Sets the record.
      Parameters:
      record - the new record
    • setRightPos

      public void setRightPos(Double rightPos)
      Sets the right pos.
      Parameters:
      rightPos - the new right pos
    • setSpread

      public void setSpread(CometTemplate.Spread spread)
      Sets the spread.
      Parameters:
      spread - the new spread
    • setStateId

      public void setStateId(Integer stateId)
      Sets the state id.
      Parameters:
      stateId - the new state id
    • setTextflowPrefix1

      public void setTextflowPrefix1(String textflowPrefix1)
      Sets the textflow prefix 1.
      Parameters:
      textflowPrefix1 - the new textflow prefix 1
    • setTextflowPrefix1Script

      public void setTextflowPrefix1Script(CometTemplateTextPrefixScript textflowPrefix1Script)
      Sets the textflow prefix 1 script.
      Parameters:
      textflowPrefix1Script - the new textflow prefix 1 script
    • setTextflowPrefix1ScriptId

      public void setTextflowPrefix1ScriptId(Integer textflowPrefix1ScriptId)
      Sets the textflow prefix 1 script id.
      Parameters:
      textflowPrefix1ScriptId - the new textflow prefix 1 script id
    • setTextflowPrefixN

      public void setTextflowPrefixN(String textflowPrefixN)
      Sets the textflow prefix N.
      Parameters:
      textflowPrefixN - the new textflow prefix N
    • setTextflowPrefixNScript

      public void setTextflowPrefixNScript(CometTemplateTextPrefixScript textflowPrefixNScript)
      Sets the textflow prefix N script.
      Parameters:
      textflowPrefixNScript - the new textflow prefix N script
    • setTextflowPrefixNScriptId

      public void setTextflowPrefixNScriptId(Integer textflowPrefixNScriptId)
      Sets the textflow prefix N script id.
      Parameters:
      textflowPrefixNScriptId - the new textflow prefix N script id
    • setTopPos

      public void setTopPos(Double topPos)
      Sets the top pos.
      Parameters:
      topPos - the new top pos
    • setTypeId

      public void setTypeId(Integer typeId)
      Sets the type id.
      Parameters:
      typeId - the new type id
    • getPageBreak

      public CometTemplate.PageBreak getPageBreak()
      Gets the page break.
      Returns:
      the page break
    • setPageBreak

      public void setPageBreak(CometTemplate.PageBreak pageBreak)
      Sets the page break.
      Parameters:
      pageBreak - the new page break
    • isTemplateMaster

      public boolean isTemplateMaster()
      Checks if is template master.
      Returns:
      true, if is template master
    • references

      public final boolean references(CometTemplate other)
      References.
      Parameters:
      other - the other
      Returns:
      true, if successful
    • discards

      public final boolean discards(CometTemplate other)
      Discards.
      Parameters:
      other - the other
      Returns:
      true, if successful
    • getTopTemplates

      public static final Collection<CometTemplate> getTopTemplates(Collection<CometTemplate> in)
      Gets the top templates.
      Parameters:
      in - the in
      Returns:
      the top templates
    • contains

      public static final boolean contains(List<CometTemplate> templates, int id)
      Contains.
      Parameters:
      templates - the templates
      id - the id
      Returns:
      true, if successful
    • contains

      public static final boolean contains(List<CometTemplate> templates, CometTemplate search)
      Contains.
      Parameters:
      templates - the templates
      search - the search
      Returns:
      true, if successful
    • getHasMinSize

      public Boolean getHasMinSize()
      Gets the checks for min size.
      Returns:
      the checks for min size
    • setHasMinSize

      public void setHasMinSize(Boolean hasMinSize)
      Sets the checks for min size.
      Parameters:
      hasMinSize - the new checks for min size