Interface Comet
Deprecated.
Internal use only
The Interface Comet.
-
Method Summary
Modifier and TypeMethodDescriptionbooleanaddSpreadOrPage(Renderer.DocumentTarget target, int count, String masterpageName, Options options) Deprecated.Adds the spread or page.booleanapplyMasterpage(Renderer.DocumentTarget target, String masterpageName, Options options) Deprecated.Apply masterpage.intbuild(Renderer.DocumentTarget target, String itemsXML, double x, double y, Options options) Deprecated.Builds the.booleancometDeleteCometGroup(Renderer.DocumentTarget target, Renderer.ReorganizeLevel reorganize, Options options) Deprecated.Comet delete comet group.jakarta.activation.DataHandler[]cometGroupGetPreviews(Renderer.DocumentTarget target, double resolution, Options options) Deprecated.Comet group get previews.intcometGroupImport(Renderer.DocumentTarget target, String fromPath, int groupId, double left, double top, Options options) Deprecated.Comet group import.intcometGroupInsertAfter(Renderer.DocumentTarget target, int templateId, RecordId recordId, Renderer.ReorganizeLevel reorganize, Options options) Deprecated.Comet group insert after.intcometGroupInsertBefore(Renderer.DocumentTarget target, int templateId, RecordId recordId, Renderer.ReorganizeLevel reorganize, Options options) Deprecated.Comet group insert before.booleancometGroupMoveBy(Renderer.DocumentTarget target, double offsetX, double offsetY, Options options) Deprecated.Comet group move by.booleancometGroupMoveTo(Renderer.DocumentTarget target, int groupId, double left, double top, Options options) Deprecated.Comet group move to.intcometGroupReplaceGroup(Renderer.DocumentTarget target, int templateId, RecordId recordId, Renderer.ReorganizeLevel reorganize, Options options) Deprecated.Comet group replace group.booleandeleteSpreadOrPage(Renderer.DocumentTarget target, int count, Options options) Deprecated.Delete spread or page.booleandocumentClose(Renderer.DocumentTarget target, Options options) Deprecated.Document close.booleandocumentCreate(Renderer.DocumentTarget target, Options options) Deprecated.Document create.booleandocumentDuplicate(Renderer.DocumentTarget target, String newPath, Options options) Deprecated.Document duplicate.jakarta.activation.DataHandlerdocumentGeneratePDF(Renderer.DocumentTarget target, String pdfprofile, Options options) Deprecated.Document generate PDF.String[]documentGetLayers(Renderer.DocumentTarget target, Options options) Deprecated.Document get layers.intdocumentGetPageCount(Renderer.DocumentTarget target, Options options) Deprecated.Document get page count.intdocumentGetSpreadCount(Renderer.DocumentTarget target, Options options) Deprecated.Document get spread count.booleandocumentOpen(Renderer.DocumentTarget target, boolean openoriginal, Options options) Deprecated.Document open.booleandocumentReorganize(Renderer.DocumentTarget target, int pageIndex, Renderer.ReorganizeLevel reorganize, Options options) Deprecated.Document reorganize.booleandocumentSave(Renderer.DocumentTarget target, Options options) Deprecated.Document save.booleandocumentSaveAs(Renderer.DocumentTarget target, String newPath, Options options) Deprecated.Document save as.booleandocumentSetup(Renderer.DocumentTarget target, boolean applyAdaption, Options options) Deprecated.Document setup.booleanelementDelete(Renderer.DocumentTarget target, int elementId, Options options) Deprecated.Element delete.booleanelementDeletePara(Renderer.DocumentTarget target, int paragraph, Options options) Deprecated.Element delete para.booleanelementInsertPara(Renderer.DocumentTarget target, int paragraph, boolean before, String value, Options options) Deprecated.Element insert para.booleanelementMove(Renderer.DocumentTarget target, int elementId, double x, double y, Options options) Deprecated.Element move.booleanelementSetCellValue(Renderer.DocumentTarget target, int col, int row, String value, Options options) Deprecated.Element set cell value.booleanelementSetImage(Renderer.DocumentTarget target, jakarta.activation.DataHandler value, Options options) Deprecated.Element set image.booleanelementSetImagePath(Renderer.DocumentTarget target, String imgPath, Options options) Deprecated.Element set image path.booleanelementSetValue(Renderer.DocumentTarget target, int paragraph, String value, Options options) Deprecated.Element set value.booleanelementTransform(Renderer.DocumentTarget target, Options options) Deprecated.Element transform.execCScript(Renderer.Target target, int actionId, String argument, Options options, String pdfProfile) Deprecated.Exec C script.execCScriptCode(Renderer.Target target, String cscript, String argument, Options options, String pdfProfile) Deprecated.Exec C script code.booleanexecTemplate(Renderer.DocumentTarget target, int templateId, RecordId recordId, String path, Options options) Deprecated.Exec template.jakarta.activation.DataHandlergeneratePDF(Renderer.DocumentTarget target, String parentList, String pdfProfile, Options options) Deprecated.Generate PDF.getCometGroups(Renderer.DocumentTarget target, Options options) Deprecated.Gets the comet groups.intDeprecated.Gets the document count.String[]Deprecated.Gets the document list.getDocumentPackage(Renderer.DocumentTarget target, Options options) Deprecated.Gets the document package.getElements(Renderer.DocumentTarget target, Options options) Deprecated.Gets the elements.jakarta.activation.DataHandlergetIdML(Renderer.DocumentTarget target, String idmlPart, Options options) Deprecated.Gets the id ML.jakarta.activation.DataHandlergetItems(Renderer.DocumentTarget target, Options options) Deprecated.Gets the items.getNotes(Renderer.DocumentTarget target, Options options) Deprecated.Gets the notes.String[]getPDFProfiles(Renderer.DocumentTarget target, Options options) Deprecated.Gets the PDF profiles.getPlaceholders(Renderer.DocumentTarget target, boolean evaluateSyncState, Options options) Deprecated.Gets the placeholders.jakarta.activation.DataHandlergetPreview(Renderer.DocumentTarget target, double resolution, Options options) Deprecated.Gets the preview.jakarta.activation.DataHandlergetPreviewOfClipping(Renderer.DocumentTarget target, double x, double y, double width, double height, double resolution, Options options) Deprecated.Gets the preview of clipping.Deprecated.Gets the renderer OS.getSpreads(Renderer.DocumentTarget target, Options options) Deprecated.Gets the spreads.Deprecated.Gets the stderr of the last command executed.Deprecated.Gets the stdout of the last command executed.jakarta.activation.DataHandlergetSWF(Renderer.DocumentTarget target, String parentIds, Options options) Deprecated.Gets the swf.intgetTemplateId(Renderer.DocumentTarget target, Options options) Deprecated.Gets the template id.getType()Deprecated.Gets the type.booleanloadPlaceholders(Renderer.DocumentTarget target, int[] placeholderIds, RecordId recordid, Options options) Deprecated.Load placeholders.jakarta.activation.DataHandlermatchItems(Renderer.DocumentTarget target, Source itemsXML, Options options) Deprecated.Match items.booleanmodifyCometGroup(Renderer.DocumentTarget target, int[] targetElements, String cmd, Options options) Deprecated.Modify comet group.booleanmoveSpreadsOrPages(Renderer.DocumentTarget target, int startSpreadOrPage, int count, Options options) Deprecated.Move spreads or pages.booleanpageSetPlaceholderImage(Renderer.DocumentTarget target, int placeholderid, RecordId recordid, jakarta.activation.DataHandler value, boolean execsavemethod, Options options) Deprecated.Page set placeholder image.booleanpageSetPlaceholderImagePath(Renderer.DocumentTarget target, int placeholderid, RecordId recordid, String imgPath, boolean execsavemethod, Options options) Deprecated.Page set placeholder image path.longping(int run) Deprecated.Ping.intplaceDocument(Renderer.DocumentTarget target, jakarta.activation.DataHandler data, double absLeft, double absTop, boolean createCometGroup, Options options) Deprecated.Place document.booleanplaceholderSetValue(Renderer.DocumentTarget target, int placeholderid, RecordId recordid, String value, boolean execsavemethod, Options options) Deprecated.Placeholder set value.booleanplaceholderUpdate(Renderer.DocumentTarget target, Options options) Deprecated.Placeholder update.intplaceTemplate(Renderer.DocumentTarget target, int templateId, RecordId recordid, double x, double y, Renderer.ReorganizeLevel reorganize, Options options) Deprecated.Place template.booleanreloadConfig(String service, String config, Options options) Deprecated.Reload config.voidDeprecated.Resets the connection status.voidDeprecated.resetStatus will be called before every Comet operation and allows the Comet implementation to reset some states before executing the next operation.voidsetConnectVerifier(String verifier) Deprecated.Sets the connect verifier.booleansetItems(Renderer.DocumentTarget target, Source items, Options options) Deprecated.Sets the items.booleansetNotes(Renderer.DocumentTarget target, String notes, Options options) Deprecated.Sets the notes.voidDeprecated.Sets the renderer OS.booleansetTemplateId(Renderer.DocumentTarget target, int templateId, Options options) Deprecated.Sets the template id.jakarta.activation.DataHandlerspreadCometGroupsPreview(Renderer.DocumentTarget target, int[] groupIds, double resolution, Options options) Deprecated.Spread comet groups preview.jakarta.activation.DataHandlerspreadElementsPreview(Renderer.DocumentTarget target, int[] elementIds, double resolution, Options options) Deprecated.Spread elements preview.jakarta.activation.DataHandlerspreadExportCometGroups(Renderer.DocumentTarget target, int[] groupIds, Options options) Deprecated.Spread export comet groups.jakarta.activation.DataHandlerspreadExportElements(Renderer.DocumentTarget targetx, int[] elementIds, Options options) Deprecated.Spread export elements.int[]spreadGetPages(Renderer.DocumentTarget target, Options options) Deprecated.Spread get pages.booleanDeprecated.Supports file type.booleansyncPlaceholders(Renderer.DocumentTarget target, int[] placeholderIds, RecordId recordId, Options options) Deprecated.Sync placeholders.booleanDeprecated.Use.
-
Method Details
-
addSpreadOrPage
boolean addSpreadOrPage(Renderer.DocumentTarget target, int count, String masterpageName, Options options) throws PubServerException Deprecated.Adds the spread or page.- Parameters:
target- the targetcount- the countmasterpageName- the masterpage nameoptions- the options- Returns:
- true, if successful
- Throws:
PubServerException- the pub server exceptionPubServerException
-
applyMasterpage
boolean applyMasterpage(Renderer.DocumentTarget target, String masterpageName, Options options) throws PubServerException Deprecated.Apply masterpage.- Parameters:
target- the targetmasterpageName- the masterpage nameoptions- the options- Returns:
- true, if successful
- Throws:
PubServerException- the pub server exceptionPubServerException
-
build
int build(Renderer.DocumentTarget target, String itemsXML, double x, double y, Options options) throws PubServerException Deprecated.Builds the.- Parameters:
target- the targetitemsXML- the items XMLx- the xy- the yoptions- the options- Returns:
- the int
- Throws:
PubServerException- the pub server exceptionPubServerException
-
cometDeleteCometGroup
boolean cometDeleteCometGroup(Renderer.DocumentTarget target, Renderer.ReorganizeLevel reorganize, Options options) throws PubServerException Deprecated.Comet delete comet group.- Parameters:
target- the targetreorganize- the reorganizeoptions- the options- Returns:
- true, if successful
- Throws:
PubServerException- the pub server exceptionPubServerException
-
cometGroupGetPreviews
jakarta.activation.DataHandler[] cometGroupGetPreviews(Renderer.DocumentTarget target, double resolution, Options options) throws PubServerException Deprecated.Comet group get previews.- Parameters:
target- the targetresolution- the resolutionoptions- the options- Returns:
- the data handler[]
- Throws:
PubServerException- the pub server exceptionPubServerException
-
cometGroupImport
int cometGroupImport(Renderer.DocumentTarget target, String fromPath, int groupId, double left, double top, Options options) throws PubServerException Deprecated.Comet group import.- Parameters:
target- the targetfromPath- the from pathgroupId- the group idleft- the lefttop- the topoptions- the options- Returns:
- the int
- Throws:
PubServerException- the pub server exceptionPubServerException
-
cometGroupInsertAfter
int cometGroupInsertAfter(Renderer.DocumentTarget target, int templateId, RecordId recordId, Renderer.ReorganizeLevel reorganize, Options options) throws PubServerException Deprecated.Comet group insert after.- Parameters:
target- the targettemplateId- the template idrecordId- the record idreorganize- the reorganizeoptions- the options- Returns:
- the int
- Throws:
PubServerException- the pub server exceptionPubServerException
-
cometGroupInsertBefore
int cometGroupInsertBefore(Renderer.DocumentTarget target, int templateId, RecordId recordId, Renderer.ReorganizeLevel reorganize, Options options) throws PubServerException Deprecated.Comet group insert before.- Parameters:
target- the targettemplateId- the template idrecordId- the record idreorganize- the reorganizeoptions- the options- Returns:
- the int
- Throws:
PubServerException- the pub server exceptionPubServerException
-
cometGroupMoveBy
boolean cometGroupMoveBy(Renderer.DocumentTarget target, double offsetX, double offsetY, Options options) throws PubServerException Deprecated.Comet group move by.- Parameters:
target- the targetoffsetX- the offset XoffsetY- the offset Yoptions- the options- Returns:
- true, if successful
- Throws:
PubServerException- the pub server exceptionPubServerException
-
cometGroupMoveTo
boolean cometGroupMoveTo(Renderer.DocumentTarget target, int groupId, double left, double top, Options options) throws PubServerException Deprecated.Comet group move to.- Parameters:
target- the targetgroupId- the group idleft- the lefttop- the topoptions- the options- Returns:
- true, if successful
- Throws:
PubServerException- the pub server exceptionPubServerException
-
cometGroupReplaceGroup
int cometGroupReplaceGroup(Renderer.DocumentTarget target, int templateId, RecordId recordId, Renderer.ReorganizeLevel reorganize, Options options) throws PubServerException Deprecated.Comet group replace group.- Parameters:
target- the targettemplateId- the template idrecordId- the record idreorganize- the reorganizeoptions- the options- Returns:
- the int
- Throws:
PubServerException- the pub server exceptionPubServerException
-
deleteSpreadOrPage
boolean deleteSpreadOrPage(Renderer.DocumentTarget target, int count, Options options) throws PubServerException Deprecated.Delete spread or page.- Parameters:
target- the targetcount- the countoptions- the options- Returns:
- true, if successful
- Throws:
PubServerException- the pub server exceptionPubServerException
-
documentClose
Deprecated.Document close.- Parameters:
target- the targetoptions- the options- Returns:
- true, if successful
- Throws:
PubServerException- the pub server exceptionPubServerException
-
documentCreate
Deprecated.Document create.- Parameters:
target- the targetoptions- the options- Returns:
- true, if successful
- Throws:
PubServerException- the pub server exceptionPubServerException
-
documentDuplicate
boolean documentDuplicate(Renderer.DocumentTarget target, String newPath, Options options) throws PubServerException Deprecated.Document duplicate.- Parameters:
target- the targetnewPath- the new pathoptions- the options- Returns:
- true, if successful
- Throws:
PubServerException- the pub server exceptionPubServerException
-
documentGeneratePDF
jakarta.activation.DataHandler documentGeneratePDF(Renderer.DocumentTarget target, String pdfprofile, Options options) throws PubServerException Deprecated.Document generate PDF.- Parameters:
target- the targetpdfprofile- the pdfprofileoptions- the options- Returns:
- the data handler
- Throws:
PubServerException- the pub server exceptionPubServerException
-
documentGetLayers
String[] documentGetLayers(Renderer.DocumentTarget target, Options options) throws PubServerException Deprecated.Document get layers.- Parameters:
target- the targetoptions- the options- Returns:
- the string[]
- Throws:
PubServerException- the pub server exceptionPubServerException
-
documentGetPageCount
Deprecated.Document get page count.- Parameters:
target- the targetoptions- the options- Returns:
- the int
- Throws:
PubServerException- the pub server exceptionPubServerException
-
documentGetSpreadCount
int documentGetSpreadCount(Renderer.DocumentTarget target, Options options) throws PubServerException Deprecated.Document get spread count.- Parameters:
target- the targetoptions- the options- Returns:
- the int
- Throws:
PubServerException- the pub server exceptionPubServerException
-
documentOpen
boolean documentOpen(Renderer.DocumentTarget target, boolean openoriginal, Options options) throws PubServerException Deprecated.Document open.- Parameters:
target- the targetopenoriginal- the openoriginaloptions- the options- Returns:
- true, if successful
- Throws:
PubServerException- the pub server exceptionPubServerException
-
documentReorganize
boolean documentReorganize(Renderer.DocumentTarget target, int pageIndex, Renderer.ReorganizeLevel reorganize, Options options) throws PubServerException Deprecated.Document reorganize.- Parameters:
target- the targetpageIndex- the page indexreorganize- the reorganizeoptions- the options- Returns:
- true, if successful
- Throws:
PubServerException- the pub server exceptionPubServerException
-
documentSave
Deprecated.Document save.- Parameters:
target- the targetoptions- the options- Returns:
- true, if successful
- Throws:
PubServerException- the pub server exceptionPubServerException
-
documentSaveAs
boolean documentSaveAs(Renderer.DocumentTarget target, String newPath, Options options) throws PubServerException Deprecated.Document save as.- Parameters:
target- the targetnewPath- the new pathoptions- the options- Returns:
- true, if successful
- Throws:
PubServerException- the pub server exceptionPubServerException
-
documentSetup
boolean documentSetup(Renderer.DocumentTarget target, boolean applyAdaption, Options options) throws PubServerException Deprecated.Document setup.- Parameters:
target- the targetapplyAdaption- the apply adaptionoptions- the options- Returns:
- true, if successful
- Throws:
PubServerException- the pub server exceptionPubServerException
-
elementDelete
boolean elementDelete(Renderer.DocumentTarget target, int elementId, Options options) throws PubServerException Deprecated.Element delete.- Parameters:
target- the targetelementId- the element idoptions- the options- Returns:
- true, if successful
- Throws:
PubServerException- the pub server exceptionPubServerException
-
elementDeletePara
boolean elementDeletePara(Renderer.DocumentTarget target, int paragraph, Options options) throws PubServerException Deprecated.Element delete para.- Parameters:
target- the targetparagraph- the paragraphoptions- the options- Returns:
- true, if successful
- Throws:
PubServerException- the pub server exceptionPubServerException
-
elementInsertPara
boolean elementInsertPara(Renderer.DocumentTarget target, int paragraph, boolean before, String value, Options options) throws PubServerException Deprecated.Element insert para.- Parameters:
target- the targetparagraph- the paragraphbefore- the beforevalue- the valueoptions- the options- Returns:
- true, if successful
- Throws:
PubServerException- the pub server exceptionPubServerException
-
elementMove
boolean elementMove(Renderer.DocumentTarget target, int elementId, double x, double y, Options options) throws PubServerException Deprecated.Element move.- Parameters:
target- the targetelementId- the element idx- the xy- the yoptions- the options- Returns:
- true, if successful
- Throws:
PubServerException- the pub server exceptionPubServerException
-
elementSetCellValue
boolean elementSetCellValue(Renderer.DocumentTarget target, int col, int row, String value, Options options) throws PubServerException Deprecated.Element set cell value.- Parameters:
target- the targetcol- the colrow- the rowvalue- the valueoptions- the options- Returns:
- true, if successful
- Throws:
PubServerException- the pub server exceptionPubServerException
-
elementSetImage
boolean elementSetImage(Renderer.DocumentTarget target, jakarta.activation.DataHandler value, Options options) throws PubServerException Deprecated.Element set image.- Parameters:
target- the targetvalue- the valueoptions- the options- Returns:
- true, if successful
- Throws:
PubServerException- the pub server exceptionPubServerException
-
elementSetImagePath
boolean elementSetImagePath(Renderer.DocumentTarget target, String imgPath, Options options) throws PubServerException Deprecated.Element set image path.- Parameters:
target- the targetimgPath- the img pathoptions- the options- Returns:
- true, if successful
- Throws:
PubServerException- the pub server exceptionPubServerException
-
elementSetValue
boolean elementSetValue(Renderer.DocumentTarget target, int paragraph, String value, Options options) throws PubServerException Deprecated.Element set value.- Parameters:
target- the targetparagraph- the paragraphvalue- the valueoptions- the options- Returns:
- true, if successful
- Throws:
PubServerException- the pub server exceptionPubServerException
-
elementTransform
Deprecated.Element transform.- Parameters:
target- the targetoptions- the options- Returns:
- true, if successful
- Throws:
PubServerException- the pub server exceptionPubServerException
-
execCScript
String execCScript(Renderer.Target target, int actionId, String argument, Options options, String pdfProfile) throws PubServerException Deprecated.Exec C script.- Parameters:
target- the targetactionId- the action idargument- the argumentoptions- the optionspdfProfile- the pdf profile- Returns:
- the string
- Throws:
PubServerException- the pub server exceptionPubServerException
-
execCScriptCode
String execCScriptCode(Renderer.Target target, String cscript, String argument, Options options, String pdfProfile) throws PubServerException Deprecated.Exec C script code.- Parameters:
target- the targetcscript- the cscriptargument- the argumentoptions- the optionspdfProfile- the pdf profile- Returns:
- the string
- Throws:
PubServerException- the pub server exceptionPubServerException
-
execTemplate
boolean execTemplate(Renderer.DocumentTarget target, int templateId, RecordId recordId, String path, Options options) throws PubServerException Deprecated.Exec template.- Parameters:
target- the targettemplateId- the template idrecordId- the record idpath- the pathoptions- the options- Returns:
- true, if successful
- Throws:
PubServerException- the pub server exceptionPubServerException
-
generatePDF
jakarta.activation.DataHandler generatePDF(Renderer.DocumentTarget target, String parentList, String pdfProfile, Options options) throws PubServerException Deprecated.Generate PDF.- Parameters:
target- the targetparentList- the parent listpdfProfile- the pdf profileoptions- the options- Returns:
- the data handler
- Throws:
PubServerException- the pub server exceptionPubServerException
-
getCometGroups
Deprecated.Gets the comet groups.- Parameters:
target- the targetoptions- the options- Returns:
- the comet groups
- Throws:
PubServerException- the pub server exceptionPubServerException
-
getDocumentCount
Deprecated.Gets the document count.- Returns:
- the document count
- Throws:
PubServerException- the pub server exceptionPubServerException
-
getDocumentList
Deprecated.Gets the document list.- Returns:
- the document list
- Throws:
PubServerException- the pub server exceptionPubServerException
-
getDocumentPackage
FileDataHandler getDocumentPackage(Renderer.DocumentTarget target, Options options) throws PubServerException Deprecated.Gets the document package.- Parameters:
target- the targetoptions- the options- Returns:
- the document package
- Throws:
PubServerException- the pub server exceptionPubServerException
-
getElements
Deprecated.Gets the elements.- Parameters:
target- the targetoptions- the options- Returns:
- the elements
- Throws:
PubServerException- the pub server exceptionPubServerException
-
getIdML
jakarta.activation.DataHandler getIdML(Renderer.DocumentTarget target, String idmlPart, Options options) throws PubServerException Deprecated.Gets the id ML.- Parameters:
target- the targetidmlPart- the idml partoptions- the options- Returns:
- the id ML
- Throws:
PubServerException- the pub server exceptionPubServerException
-
getItems
jakarta.activation.DataHandler getItems(Renderer.DocumentTarget target, Options options) throws PubServerException Deprecated.Gets the items.- Parameters:
target- the targetoptions- the options- Returns:
- the items
- Throws:
PubServerException- the pub server exceptionPubServerException
-
getNotes
Deprecated.Gets the notes.- Parameters:
target- the targetoptions- the options- Returns:
- the notes
- Throws:
PubServerException- the pub server exceptionPubServerException
-
getPDFProfiles
Deprecated.Gets the PDF profiles.- Parameters:
target- the targetoptions- the options- Returns:
- the PDF profiles
- Throws:
PubServerException- the pub server exceptionPubServerException
-
getPlaceholders
String getPlaceholders(Renderer.DocumentTarget target, boolean evaluateSyncState, Options options) throws PubServerException Deprecated.Gets the placeholders.- Parameters:
target- the targetevaluateSyncState- the evaluate sync stateoptions- the options- Returns:
- the placeholders
- Throws:
PubServerException- the pub server exceptionPubServerException
-
getPreview
jakarta.activation.DataHandler getPreview(Renderer.DocumentTarget target, double resolution, Options options) throws PubServerException Deprecated.Gets the preview.- Parameters:
target- the targetresolution- the resolutionoptions- the options- Returns:
- the preview
- Throws:
PubServerException- the pub server exceptionPubServerException
-
getPreviewOfClipping
jakarta.activation.DataHandler getPreviewOfClipping(Renderer.DocumentTarget target, double x, double y, double width, double height, double resolution, Options options) throws PubServerException Deprecated.Gets the preview of clipping.- Parameters:
target- the targetx- the xy- the ywidth- the widthheight- the heightresolution- the resolutionoptions- the options- Returns:
- the preview of clipping
- Throws:
PubServerException- the pub server exceptionPubServerException
-
getRendererOS
Renderer.OS getRendererOS()Deprecated.Gets the renderer OS.- Returns:
- the renderer OS
-
getSpreads
Deprecated.Gets the spreads.- Parameters:
target- the targetoptions- the options- Returns:
- the spreads
- Throws:
PubServerException- the pub server exceptionPubServerException
-
getStderr
String getStderr()Deprecated.Gets the stderr of the last command executed.- Returns:
- the stderr
-
getStdout
String getStdout()Deprecated.Gets the stdout of the last command executed.- Returns:
- the stdout
-
getSWF
jakarta.activation.DataHandler getSWF(Renderer.DocumentTarget target, String parentIds, Options options) throws PubServerException Deprecated.Gets the swf.- Parameters:
target- the targetparentIds- the parent idsoptions- the options- Returns:
- the swf
- Throws:
PubServerException- the pub server exceptionPubServerException
-
getTemplateId
Deprecated.Gets the template id.- Parameters:
target- the targetoptions- the options- Returns:
- the template id
- Throws:
PubServerException- the pub server exceptionPubServerException
-
getType
Renderer.Type getType()Deprecated.Gets the type.- Returns:
- the type
-
loadPlaceholders
boolean loadPlaceholders(Renderer.DocumentTarget target, int[] placeholderIds, RecordId recordid, Options options) throws PubServerException Deprecated.Load placeholders.- Parameters:
target- the targetplaceholderIds- the placeholder idsrecordid- the recordidoptions- the options- Returns:
- true, if successful
- Throws:
PubServerException- the pub server exceptionPubServerException
-
matchItems
jakarta.activation.DataHandler matchItems(Renderer.DocumentTarget target, Source itemsXML, Options options) throws PubServerException Deprecated.Match items.- Parameters:
target- the targetitemsXML- the items XMLoptions- the options- Returns:
- the data handler
- Throws:
PubServerException- the pub server exceptionPubServerException
-
modifyCometGroup
boolean modifyCometGroup(Renderer.DocumentTarget target, int[] targetElements, String cmd, Options options) throws PubServerException Deprecated.Modify comet group.- Parameters:
target- the targettargetElements- the target elementscmd- the cmdoptions- the options- Returns:
- true, if successful
- Throws:
PubServerException- the pub server exceptionPubServerException
-
moveSpreadsOrPages
boolean moveSpreadsOrPages(Renderer.DocumentTarget target, int startSpreadOrPage, int count, Options options) throws PubServerException Deprecated.Move spreads or pages.- Parameters:
target- the targetstartSpreadOrPage- the start spread or pagecount- the countoptions- the options- Returns:
- true, if successful
- Throws:
PubServerException- the pub server exceptionPubServerException
-
pageSetPlaceholderImage
boolean pageSetPlaceholderImage(Renderer.DocumentTarget target, int placeholderid, RecordId recordid, jakarta.activation.DataHandler value, boolean execsavemethod, Options options) throws PubServerException Deprecated.Page set placeholder image.- Parameters:
target- the targetplaceholderid- the placeholderidrecordid- the recordidvalue- the valueexecsavemethod- the execsavemethodoptions- the options- Returns:
- true, if successful
- Throws:
PubServerException- the pub server exceptionPubServerException
-
pageSetPlaceholderImagePath
boolean pageSetPlaceholderImagePath(Renderer.DocumentTarget target, int placeholderid, RecordId recordid, String imgPath, boolean execsavemethod, Options options) throws PubServerException Deprecated.Page set placeholder image path.- Parameters:
target- the targetplaceholderid- the placeholderidrecordid- the recordidimgPath- the img pathexecsavemethod- the execsavemethodoptions- the options- Returns:
- true, if successful
- Throws:
PubServerException- the pub server exceptionPubServerException
-
ping
Deprecated.Ping.- Parameters:
run- the run- Returns:
- the long
- Throws:
PubServerException- the pub server exceptionPubServerException
-
placeDocument
int placeDocument(Renderer.DocumentTarget target, jakarta.activation.DataHandler data, double absLeft, double absTop, boolean createCometGroup, Options options) throws PubServerException Deprecated.Place document.- Parameters:
target- the targetdata- the dataabsLeft- the abs leftabsTop- the abs topcreateCometGroup- the create comet groupoptions- the options- Returns:
- the int
- Throws:
PubServerException- the pub server exceptionPubServerException
-
placeholderSetValue
boolean placeholderSetValue(Renderer.DocumentTarget target, int placeholderid, RecordId recordid, String value, boolean execsavemethod, Options options) throws PubServerException Deprecated.Placeholder set value.- Parameters:
target- the targetplaceholderid- the placeholderidrecordid- the recordidvalue- the valueexecsavemethod- the execsavemethodoptions- the options- Returns:
- true, if successful
- Throws:
PubServerException- the pub server exceptionPubServerException
-
placeholderUpdate
boolean placeholderUpdate(Renderer.DocumentTarget target, Options options) throws PubServerException Deprecated.Placeholder update.- Parameters:
target- the targetoptions- the options- Returns:
- true, if successful
- Throws:
PubServerException- the pub server exceptionPubServerException
-
placeTemplate
int placeTemplate(Renderer.DocumentTarget target, int templateId, RecordId recordid, double x, double y, Renderer.ReorganizeLevel reorganize, Options options) throws PubServerException Deprecated.Place template.- Parameters:
target- the targettemplateId- the template idrecordid- the recordidx- the xy- the yreorganize- the reorganizeoptions- the options- Returns:
- the int
- Throws:
PubServerException- the pub server exceptionPubServerException
-
reloadConfig
Deprecated.Reload config.- Parameters:
service- the serviceconfig- the configoptions- the options- Returns:
- true, if successful
- Throws:
PubServerException- the pub server exceptionPubServerException
-
resetConnectionStatus
void resetConnectionStatus()Deprecated.Resets the connection status. -
resetStatus
void resetStatus()Deprecated.resetStatus will be called before every Comet operation and allows the Comet implementation to reset some states before executing the next operation. -
setConnectVerifier
Deprecated.Sets the connect verifier.- Parameters:
verifier- the new connect verifier
-
setItems
boolean setItems(Renderer.DocumentTarget target, Source items, Options options) throws PubServerException Deprecated.Sets the items.- Parameters:
target- the targetitems- the itemsoptions- the options- Returns:
- true, if successful
- Throws:
PubServerException- the pub server exceptionPubServerException
-
setNotes
boolean setNotes(Renderer.DocumentTarget target, String notes, Options options) throws PubServerException Deprecated.Sets the notes.- Parameters:
target- the targetnotes- the notesoptions- the options- Returns:
- true, if successful
- Throws:
PubServerException- the pub server exceptionPubServerException
-
setRendererOS
Deprecated.Sets the renderer OS.- Parameters:
os- the new renderer OS
-
setTemplateId
boolean setTemplateId(Renderer.DocumentTarget target, int templateId, Options options) throws PubServerException Deprecated.Sets the template id.- Parameters:
target- the targettemplateId- the template idoptions- the options- Returns:
- true, if successful
- Throws:
PubServerException- the pub server exceptionPubServerException
-
spreadCometGroupsPreview
jakarta.activation.DataHandler spreadCometGroupsPreview(Renderer.DocumentTarget target, int[] groupIds, double resolution, Options options) throws PubServerException Deprecated.Spread comet groups preview.- Parameters:
target- the targetgroupIds- the group idsresolution- the resolutionoptions- the options- Returns:
- the data handler
- Throws:
PubServerException- the pub server exceptionPubServerException
-
spreadElementsPreview
jakarta.activation.DataHandler spreadElementsPreview(Renderer.DocumentTarget target, int[] elementIds, double resolution, Options options) throws PubServerException Deprecated.Spread elements preview.- Parameters:
target- the targetelementIds- the element idsresolution- the resolutionoptions- the options- Returns:
- the data handler
- Throws:
PubServerException- the pub server exceptionPubServerException
-
spreadExportCometGroups
jakarta.activation.DataHandler spreadExportCometGroups(Renderer.DocumentTarget target, int[] groupIds, Options options) throws PubServerException Deprecated.Spread export comet groups.- Parameters:
target- the targetgroupIds- the group idsoptions- the options- Returns:
- the data handler
- Throws:
PubServerException- the pub server exceptionPubServerException
-
spreadExportElements
jakarta.activation.DataHandler spreadExportElements(Renderer.DocumentTarget targetx, int[] elementIds, Options options) throws PubServerException Deprecated.Spread export elements.- Parameters:
targetx- the targetxelementIds- the element idsoptions- the options- Returns:
- the data handler
- Throws:
PubServerException- the pub server exceptionPubServerException
-
spreadGetPages
Deprecated.Spread get pages.- Parameters:
target- the targetoptions- the options- Returns:
- the int[]
- Throws:
PubServerException- the pub server exceptionPubServerException
-
supportsFileType
Deprecated.Supports file type.- Parameters:
type- the type- Returns:
- true, if successful
-
syncPlaceholders
boolean syncPlaceholders(Renderer.DocumentTarget target, int[] placeholderIds, RecordId recordId, Options options) throws PubServerException Deprecated.Sync placeholders.- Parameters:
target- the targetplaceholderIds- the placeholder idsrecordId- the record idoptions- the options- Returns:
- true, if successful
- Throws:
PubServerException- the pub server exceptionPubServerException
-
use
boolean use(String service, String user, String password, boolean forcereconnect, Options options) throws PubServerException Deprecated.Use.- Parameters:
service- the serviceuser- the userpassword- the passwordforcereconnect- the forcereconnectoptions- the options- Returns:
- true, if successful
- Throws:
PubServerException- the pub server exceptionPubServerException
-