SVGImageProvider These utilities are built upon the java .jar libraries in the FOP distribution included with modern releases of InterSystems IRIS. More...
Public Member Functions | |
addSVGLegendToChart (chartDocument, legendSVG, legendPosition) | |
applyHTMLStyleToSVG (svgNode, htmlStyle, forBatik, suppressPadding) | |
As closely as possible copy an html css style definition to an SVG object. More... | |
calculateMaxImageHeight (metaDataJS) | |
This interprets the current page margin settings and returns the maximum. More... | |
calculateMaxImageWidth (metaDataJS) | |
This interprets the current page margin settings and returns the maximum. More... | |
clipSvgContent (svgContent, height, width, clipTargetId, clipX, clipY) | |
Create a clipPath to add to a limited copy of the svgContent that will appropriately size one page of printable content. More... | |
convertHTMLCellToSVGRect (htmlCell, geometry) | |
Given an htmlCell representing a cell of an html table, return an equivalent representation as a member of an. More... | |
convertHTMLTableToSVG (table, defaultId) | |
Create an SVG representation of a single HTML table. More... | |
convertSizeToPoint (sizeStr) | |
Given a size attribute setting, convert it to points. More... | |
createSVGTableFromResultSet (jsRS, htmlTemplateId, parms) | |
Create and return an SVG materialization of a DeepSeeResultSet client object. More... | |
createSVGTableFromZenComponent (componentId) | |
Given the ID of a Zen component, attempt to extract the primary html table. More... | |
createSVGTextCell (text, id, geometry, htmlStyle) | |
Create a fully styled cell around a particular text. More... | |
createSVGTextNode (text, id, geometry, htmlStyle) | |
Create the specific text. | |
createSvgTableFrame (refId, height, width) | |
Produce a standard SVG container for the printable tables which can get filled with. More... | |
createTempSvgContainer () | |
Create a temporary SVG container in the body of the Zen component. More... | |
destroyTempSvgContainer () | |
Remove the temporary SVG container from the Zen body. | |
dumpDOMNodeGeometry (node, level, stem, last, pst, psl, svgGroup) | |
Recursive function to dump the nesting structure and base geometry of a tree of DOM nodes. More... | |
dumpDOMTreeGeometry (root, svgGroup) | |
Output a text representation of a DOM subtree showing element nesting and basic. More... | |
getPPI () | |
Get the pixels per inch. | |
getPrintParameters () | |
Get the print parameters stored in this provider. | |
getTempSvgContainer () | |
Return the current temporary SVG container, if it exists. | |
mergeTempXSLFiles (parms, targetFileName, tempFiles) | |
Perform the merge of tempFiles into the fileName. More... | |
parseCssStyleString (cssString) | |
Parse a bare css style string into an object. | |
parseSize (size) | |
Parse a size attribute into its value and units. | |
prepareFilterTable (filterNames, filterValues, parms) | |
This method takes as input the filterNames and filterValues arrays that are commonly built. More... | |
printSVGFollowingPage (parms, pageNo, clipX, clipY, tempFiles) | |
Clip svgContent for a particular page in a multi-page pring. More... | |
producePDF (parms, fileName, outName) | |
Convert the complete XSL file to PDF and launch the viewer in a new browser tab. More... | |
removeSVGLegendFromChart (chartDocument, legendGroupId, legendPosition) | |
Pull the svg legend from the chart document. | |
setPrintParameters (parms) | |
Set the print parameters for reference when converting style information. | |
wrapSvgText (words, id, geometry, htmlStyle) | |
Return an array with the components of wrapped SVG text. | |
![]() | |
dumpSVGNode (e, svgDoc, src, intro, coda, NSPrefix, maxWidth, maxHeight) | |
Given an element, an active SVG DOM, a syntax buffer, and optional introduction and coda. More... | |
dumpSVGStyle (svgDoc, src, NSPrefix) | |
Given an active SVG DOM and a syntax buffer, extract all embedded stylesheets and. More... | |
extractSVGSource (svg, intro, coda) | |
Given an SVG DOM and (optional) introduction and coda strings containing SVG. More... | |
extractXSLFOSource (svg, intro, coda, maxWidth, maxHeight) | |
Given an SVG DOM and (optional) introduction and coda strings containing SVG. More... | |
getPageSetupDefaults () | |
Return a javascript object that contains the various default values. More... | |
getSVGDOMRoot (image) | |
Given some form of zen SVGComponent, return a pointer to the root of. More... | |
isWhiteSpace (str) | |
Quick check to test for embedded whitespace and control characters. | |
onloadHandler () | |
This client event, if present, is fired when the page is loaded. | |
reconcileDefaults (metaDataJS) | |
Set up a default page setup object, incorporating user. More... | |
saveDOMToSVGFile (svg, fileName, intro, coda) | |
Given an SVG DOM, the name of a server side file to create/overwrite, and (optional) More... | |
saveDOMToSVGStream (svg, intro, coda) | |
Given an SVG DOM and (optional) introduction and coda strings containing SVG. More... | |
saveDOMToXSLFOFile (svg, fileName, intro, coda) | |
Given an SVG DOM, the name of a server side file to create/overwrite, and (optional) More... | |
saveDOMToXSLFOStream (svg, intro, coda) | |
Given an SVG DOM and (optional) introduction and coda strings containing SVG. More... | |
saveDOMToXSLFile (svg, metaDataJS) | |
Given an SVG DOM, the name of a server side file to create/overwrite, and (optional) More... | |
saveToServer (src, fileName) | |
Client-side utility to send large data streams up to the server for external file storage. More... | |
![]() | |
dragFinishHandler (dragData) | |
This is called when a drag operation started within this component. More... | |
dragHandler () | |
This is called by the layout manager when a drag-and-drop operation. More... | |
dragNotifyHandler (dragData) | |
This is called by the layout manager when a drag operation. More... | |
dragStartHandler (dragData) | |
This is called when a drag operation is started within this component. More... | |
dropHandler () | |
This is called by the layout manager when a drag-and-drop operation. More... | |
dropStartHandler (dragData) | |
This is called when a data drop operation is started within this component. More... | |
exposeComponent () | |
This manages the ondisplay event callback handling. More... | |
getEnclosingDiv () | |
Client-side method returns the div element that encloses. More... | |
_.Library.String | getHidden () |
Return whether this component is hidden. | |
getHintElement () | |
Client-side method returns the HTML element that displays. More... | |
getLabelElement () | |
Client-side method returns the HTML element that displays. More... | |
onDisplayHandler () | |
This client callback is called from exposeComponent after. More... | |
onEndModalHandler (zindex) | |
Notification that this component is about to stop being modal. | |
onPopupAction (popupName, action, value) | |
This client event, if present, is fired when a popup page has specified. More... | |
onRefreshContents () | |
This client callback is called just from refreshContents. More... | |
onStartModalHandler (zindex) | |
Notification that this component is about to become modal. More... | |
refreshContents (sync) | |
This method, called from a client page, invokes this component's. More... | |
setHidden (flag) | |
If flag is true, hide this component. More... | |
setOverlayMode (mode) | |
Expirimental: do not use. More... | |
setProperty (property, value, value2) | |
Set the value of a named property. More... | |
startProgressBar (div) | |
Start the display of a progress bar within display. More... | |
stopProgressBar () | |
Stop the timer used by the Progress bar. | |
![]() | |
_.Library.Status | OnNew (_.Library.RawString initvalue) |
Constructor for Zen objects. More... | |
findElement (subid) | |
Client-side utility method that finds an HTML element with a. More... | |
fireOnUpdateEvent () | |
This is called when an object is updated from the server. More... | |
_.Library.String | getProperty (property, key) |
Return the value of a named property (i.e. More... | |
getSettings (settings) | |
Client-side method that returns a list of this component's. More... | |
getType () | |
Returns the component type of this object. More... | |
invokeSuper (method, args) | |
Invoke the superclass method method of the current. More... | |
isOfType (type) | |
Returns true if this object is of the given component type. More... | |
makeId (subid) | |
client-side utility method that constructs a component-specific id More... | |
onCreate () | |
This client method, if present, is called when this component is. More... | |
onDelete () | |
This client method, if present, is called when this component is. More... | |
onSerialize () | |
This client event, if present, is fired before a component. More... | |
onunloadHandler () | |
This client event, if present, is fired when the page is unloaded. More... | |
onupdateHandler () | |
This client method, if present, is fired when the object is updated from the server. | |
render () | |
This causes a component that draws its contents dynamically. More... | |
renderContents () | |
This method, if present, is called when this component. More... | |
renderSVG (document, parent) | |
This method is only needed for SVG components. More... | |
![]() | |
_.Library.Status | OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount) |
This callback method is invoked when the current object is added to the SaveSet,. More... | |
_.Library.Status | OnClose () |
This callback method is invoked by the <METHOD>Close</METHOD> method to. More... | |
_.Library.Status | OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned) |
This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More... | |
_.Library.Status | OnNew () |
This callback method is invoked by the <METHOD>New</METHOD> method to. More... | |
_.Library.Status | OnValidateObject () |
This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More... | |
![]() | |
_.Library.Status | XMLExport (_.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent, _.Library.Boolean local, _.Net.MIMEPart mimeAttachments) |
Serialize an XML enabled class as an XML document and write. More... | |
_.Library.Status | XMLExportToStream (_.Stream.Object export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent) |
Serialize an XML enabled class as an XML document and appends it to a stream. More... | |
_.Library.Status | XMLExportToString (_.Library.String export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent) |
Serialize an XML enabled class as an XML document and write it to a string. More... | |
Static Public Member Functions | |
_.Library.Status | MergeXSLFiles (pOutFile, pTargetFile, pSourceFiles, pSessionId) |
Do the work of performing the merge of two or more xsl files into a single file pOutfile. More... | |
![]() | |
_.Library.String | GenerateRootName (_.Library.String dir) |
Return a random and unique name in the given directory with an 'svg' extention for. More... | |
_.Library.String | GenerateTempName () |
Return a random and unique name in the temp directory with an 'svg' extention for. More... | |
_.Library.String | GetSystemHomeDir () |
Return the install directory of this instance. | |
_.Library.String | GetSystemTempDir () |
Return the temp directory for this system. | |
_.Library.Status | ReceiveFragment (_.Library.String outputFile, _.ZEN.proxyObject src) |
Mechanism for receiving fragmants of large data streams headed upstream from client. More... | |
_.Library.Status | RemoveFile (pFileName) |
Remove a file from the mgr/Temp directory. | |
_.Library.String | ScopeFileName (_.Library.String rawName) |
Given a user specified file name clip it to ensure that it only refers to. More... | |
![]() | |
_.Library.Status | XMLDTD (_.Library.String top, _.Library.String format, _.Library.Boolean input, dtdlist) |
Write the DTD to the current device for this XML enabled class serialized as. More... | |
_.Library.RegisteredObject | XMLNew (_.XML.Document document, _.Library.Integer node, _.Library.RegisteredObject containerOref) |
Get an instance of an XML enabled class. More... | |
_.Library.Status | XMLSchema (_.Library.String top, _.Library.String format, _.Library.String namespacePrefix, _.Library.Boolean input, _.Library.Boolean refOnly, schema) |
Write an XML Schema fragment to the current device which describes an XML enabled class and dependent classes. More... | |
_.Library.String | XMLSchemaNamespace () |
Get the namespace to which this class belongs for use in schema generation. More... | |
_.Library.Status | XMLSchemaType (_.XML.Schema schemaInstance, _.XML.Node node, _.Library.String top, _.Library.Boolean encoded, _.Library.Boolean summary, _.Library.Boolean input, _.Library.Boolean refOnly) |
Add a complexType to the schema that is respresented by an <class>XML.Schema</class> instance. More... | |
Public Attributes | |
printParameters | |
More... | |
![]() | |
align | |
Specifies how this component should be horizontally aligned within its layout cell. More... | |
containerStyle | |
CSS style applied to the td element used to contain this child component within. More... | |
dragEnabled | |
If this value is true and dragAndDrop is enabled for the page, then. More... | |
dropEnabled | |
If this value is true and dragAndDrop is enabled for the page, then. More... | |
enclosingClass | |
Optional CSS class used for this component's enclosing div. More... | |
enclosingStyle | |
Optional CSS style applied to this component's enclosing div. More... | |
error | |
Run-time value; Set to indicate an error within this component. More... | |
height | |
Specifies the height of this component with respect to its container. More... | |
hidden | |
If true, this component is hidden. More... | |
hint | |
User defined hint text used to display additional hint text for this component. More... | |
hintClass | |
Optional CSS class used for the component hint. More... | |
hintStyle | |
User defined style used for the component hint. More... | |
label | |
User defined label used to label this component. More... | |
labelClass | |
Optional CSS class used for the component label. More... | |
labelDisabledClass | |
Optional CSS class used for the component label when disabled. More... | |
labelStyle | |
User defined style used for the component label. More... | |
onafterdrag | |
onafterdrag event handler: More... | |
onbeforedrag | |
onbeforedrag event handler: More... | |
ondrag | |
ondrag event handler: More... | |
ondrop | |
ondrop event handler: More... | |
onhide | |
onhide event handler: More... | |
onrefresh | |
onrefresh event handler: More... | |
onshow | |
onshow event handler: More... | |
showLabel | |
Controls whether a label is displayed for this component. More... | |
slice | |
User-defined number of units of relative space this. More... | |
title | |
Help text (tool tip) displayed when mouse hovers over this component (or its label). More... | |
valign | |
Specifies how this component should be vertically aligned within its layout cell. More... | |
width | |
Specifies the width of this component with respect to its container. More... | |
![]() | |
aux | |
@qualifier final This is an auxiliary property that is provided More... | |
composite | |
@qualifier final For components that are created as part of a composite component, More... | |
id | |
@qualifier final This is a unique identifier that is used to distinguish this object More... | |
index | |
@qualifier final System-assigned index number used internally to identify this component. More... | |
name | |
@qualifier final Name of this object. More... | |
onupdate | |
onupdate event handler: More... | |
parent | |
@qualifier final Link to the component that contains this object More... | |
tuple | |
@qualifier final Special property indicating which tuple of a More... | |
visible | |
This property indicates whether a component is visible and thus layed out. More... | |
window | |
@qualifier final This is a client-only property that refers to the JavaScript More... | |
Static Public Attributes | |
DOMAIN = None | |
SVGImageProvider These utilities are built upon the java .jar libraries in the FOP distribution included with modern releases of InterSystems IRIS. | |
NAMESPACE = None | |
This is the XML namespace used for library components. | |
![]() | |
DEFAULTENCLOSINGCLASS = None | |
Subclasses can set this to change default enclosingClass used for this. More... | |
DEFAULTHEIGHT = None | |
Subclasses can set this to change default height for a component. | |
DEFAULTHIDDEN = None | |
Subclasses can set this to change default hidden property for a component. | |
DEFAULTHINTCLASS = None | |
Subclasses can set this to change default css class used for hints. | |
DEFAULTLABELCLASS = None | |
Subclasses can set this to change default css class used for labels. | |
DEFAULTLABELDISABLEDCLASS = None | |
Subclasses can set this to change default css class used for disabled labels. | |
DEFAULTVISIBLE = None | |
Subclasses can set this to change default visibilty for a component. | |
DEFAULTWIDTH = None | |
Subclasses can set this to change default width for a component. | |
![]() | |
DEFAULTVISIBLE = None | |
Subclasses can set this to change default visibilty for a component. | |
INCLUDEFILES = None | |
CSV list of additional include files (either .js or .css) that. More... | |
MODULE = None | |
If set, this indicates that this system component should be. More... | |
NAMESPACE = None | |
This is the XML namespace used for library components. | |
POSTCOMPILEACTIONS = None | |
This is a comma-delimited list of which post-compile actions this component. More... | |
USECOMMONDIRECTORY = None | |
If true, then the include files generated for this component, are placed in the. More... | |
XMLFORMAT = None | |
If XMLFORMAT="Literal", then only support for literal format import and export is generated. More... | |
XMLIGNOREINVALIDATTRIBUTE = None | |
By setting this to 0, we disallow use of invalid attribute names in Zen XML documents. | |
![]() | |
CAPTION = None | |
Optional name used by the Form Wizard for a class when generating forms. More... | |
JAVATYPE = None | |
The Java type to be used when exported. | |
PROPERTYVALIDATION = None | |
This parameter controls the default validation behavior for the object. More... | |
![]() | |
ATTRIBUTEQUALIFIED = None | |
ATTRIBUTEQUALIFIED controls the format of exported XML by controlling whether attributes. More... | |
ELEMENTQUALIFIED = None | |
ELEMENTQUALIFIED controls the format of exported XML. More... | |
NAMESPACE = None | |
NAMESPACE specifies the XML namespace to be used when projecting the. More... | |
SUPPRESSTYPEPREFIX = None | |
SUPPRESSTYPEPREFIX allows the type name that refers to this class. More... | |
XMLDEFAULTREFERENCE = None | |
XMLDEFAULTREFERENCE specifies the default value of the XMLREFERENCE property parameter. More... | |
XMLENABLED = None | |
If this parameter is true then XML-enabling methods. More... | |
XMLFORMAT = None | |
The XMLFORMAT parameter controls the generation of the XMLExport and XMLImport. More... | |
XMLIGNOREINVALIDATTRIBUTE = None | |
The XMLIGNOREINVALIDATTRIBUTE parameter allows the programmer to control handling of unexpected. More... | |
XMLIGNOREINVALIDTAG = None | |
The XMLIGNOREINVALIDTAG parameter allows the programmer to control handling of unexpected. More... | |
XMLIGNORENULL = None | |
XMLIGNORENULL allows the programmer to override the default XML handling. More... | |
XMLINCLUDEINGROUP = None | |
XMLINCLUDEINGROUP allows the programmer to control whether a class is included. More... | |
XMLINHERITANCE = None | |
If the XMLINHERITANCE parameter is set to "LEFT", then in the case of multiple. More... | |
XMLNAME = None | |
This parameter provides the default XMLNAME for the class. More... | |
XMLNIL = None | |
The XMLNIL class parameter controls the use of xsi:nil by XMLExport. More... | |
XMLNILNOOBJECT = None | |
The XMLNILNOOBJECT parameter allows creation of an object to be skipped for elements. More... | |
XMLPREFIX = None | |
The XMLPREFIX parameter controls the prefix to be used for the XML namespace that. More... | |
XMLSEQUENCE = None | |
If the XMLSEQUENCE = 1, then the order of the XML elements must match the. More... | |
XMLSUMMARY = None | |
The summary fields to be used when an object is referenced are specified. More... | |
XMLTYPE = None | |
This parameter provides the default XMLTYPE for the class. More... | |
XMLUNSWIZZLE = None | |
If the XMLUNSWIZZLE parameter is set to 1, then single object. More... | |
XMLUSEEMPTYELEMENT = None | |
If the XMLUSEEMPTYELEMENT parameter is set to 1, then the empty element shorthand (<tag>) More... | |
SVGImageProvider These utilities are built upon the java .jar libraries in the FOP distribution included with modern releases of InterSystems IRIS.
|
static |
Do the work of performing the merge of two or more xsl files into a single file pOutfile.
All files must be located in the mgr/Temp directory. The pTargetFile is the master file which will provide the page settings. The argument pSourceFiles is a list of file names delimited by "||". The page content of each of these files will be appended to the content of the pTargetFile spearated by a page break.
addSVGLegendToChart | ( | chartDocument, | |
legendSVG, | |||
legendPosition | |||
) |
chartDocument is the document obtained using
DeepSee.Component.deepseeSvgImageProvider:getSVGDOMRoot(chartSVGFrameId)
applyHTMLStyleToSVG | ( | svgNode, | |
htmlStyle, | |||
forBatik, | |||
suppressPadding | |||
) |
As closely as possible copy an html css style definition to an SVG object.
This can sanitize the style input for compatibility printing in Batik or retain more complex styling for browser display.
calculateMaxImageHeight | ( | metaDataJS | ) |
This interprets the current page margin settings and returns the maximum.
height available for the svg image. The value is returned in points.
calculateMaxImageWidth | ( | metaDataJS | ) |
This interprets the current page margin settings and returns the maximum.
width available for the svg image. The value is returned in points.
clipSvgContent | ( | svgContent, | |
height, | |||
width, | |||
clipTargetId, | |||
clipX, | |||
clipY | |||
) |
Create a clipPath to add to a limited copy of the svgContent that will appropriately size one page of printable content.
The function assumes a provided svgcontent which uses absolute positioning relative to the frame and produces a copy of the content visible inside the clip window.
convertHTMLCellToSVGRect | ( | htmlCell, | |
geometry | |||
) |
Given an htmlCell representing a cell of an html table, return an equivalent representation as a member of an.
svg group.
convertHTMLTableToSVG | ( | table, | |
defaultId | |||
) |
Create an SVG representation of a single HTML table.
These could be:
convertSizeToPoint | ( | sizeStr | ) |
Given a size attribute setting, convert it to points.
The size is returned in an object:
size.value
size.units
createSVGTableFromResultSet | ( | jsRS, | |
htmlTemplateId, | |||
parms | |||
) |
createSVGTableFromZenComponent | ( | componentId | ) |
createSVGTextCell | ( | text, | |
id, | |||
geometry, | |||
htmlStyle | |||
) |
Create a fully styled cell around a particular text.
The {x,y,h,w} geometry can be supplied as
this is created using geometry.
createSvgTableFrame | ( | refId, | |
height, | |||
width | |||
) |
Produce a standard SVG container for the printable tables which can get filled with.
resultset content.
createTempSvgContainer | ( | ) |
Create a temporary SVG container in the body of the Zen component.
This is used to
trigger the calcualation of bounding boxes of temporary elements that would not otherwise be committed to the DOM.
dumpDOMNodeGeometry | ( | node, | |
level, | |||
stem, | |||
last, | |||
pst, | |||
psl, | |||
svgGroup | |||
) |
Recursive function to dump the nesting structure and base geometry of a tree of DOM nodes.
node: the root the of the current subtree level: the currnet depth of recursion stem: a string of 0s and 1s used to indicate the location of leaves in the tree already encountered last: a boolean flag used to tell the current node whether or not it is the last child element of its parent pst: parentScrollTop offset psl: parentScrollLeft offset
dumpDOMTreeGeometry | ( | root, | |
svgGroup | |||
) |
Output a text representation of a DOM subtree showing element nesting and basic.
goemetry parameters starting from the given root node. To dump the entire DOM to the error console, pass this function document.body as the root.
mergeTempXSLFiles | ( | parms, | |
targetFileName, | |||
tempFiles | |||
) |
Perform the merge of tempFiles into the fileName.
This assumes tempFiles
is an array.
prepareFilterTable | ( | filterNames, | |
filterValues, | |||
parms | |||
) |
This method takes as input the filterNames and filterValues arrays that are commonly built.
for DeepSee widgets. The array is reshaped into a table that can be digested by the fo conversion utilities.
printSVGFollowingPage | ( | parms, | |
pageNo, | |||
clipX, | |||
clipY, | |||
tempFiles | |||
) |
Clip svgContent for a particular page in a multi-page pring.
This will collect all pages into the
tempFiles. Upon completion of the current page this method will advance to the next page and fire the method again to print the next temp document. Once the last page is reached, the method to merge is fired. PAGES 2-N:
producePDF | ( | parms, | |
fileName, | |||
outName | |||
) |
Convert the complete XSL file to PDF and launch the viewer in a new browser tab.
This is a terminal method in an async execution chain.
printParameters |