OverviewSingleDeprecated

jsx3.gui

class CDF

Object
->jsx3.lang.Object
  ->jsx3.app.Model
    ->jsx3.gui.Painted
      ->jsx3.gui.Block
        ->jsx3.gui.CDF

All Implemented Interfaces:

jsx3.gui.Interactive, jsx3.util.EventDispatcher, jsx3.xml.CDF, jsx3.xml.Cacheable

class CDF
extends jsx3.gui.Block
Provides a container that maps to a CDF Document in the cache. This provides a simplified mechanism for mapping forms and blocks to CDF Documents in the XML Cache. Instances of this class can nest to point to another CDF record in the same document or can point to a CDF document of their own.

Constructor Summary
void
init(strName : String)
instance initializer
Method Summary
void
Returns the CDF ID of the record to map to.
void
read(bRepaint : boolean, strRecordId : String)
Updates all mapped descendants with values from the source CDF Document
void
redrawRecord(strRecordId : String, intAction : int)
No-op.
void
setCDFId(strCDFId : String)
Sets the CDF ID of the record to map to.
void
Updates the source CDF document with values returned from mapped descendants
Methods Inherited From jsx3.xml.CDF
adoptRecord, adoptRecordBefore, convertProperties, deleteRecord, deleteRecordProperty, getRecord, getRecordIds, getRecordNode, insertRecord, insertRecordBefore, insertRecordNode, insertRecordProperty, reloadFromSource, resetData
Methods Inherited From jsx3.xml.Cacheable
clearXmlData, getNodeSet, getShareResources, getXML, getXMLId, getXMLString, getXMLTransformers, getXMLURL, getXSL, getXSLId, getXSLParams, getXSLString, getXSLURL, getXmlAsync, getXmlBind, onXmlBinding, removeXSLParam, removeXSLParams, resetCacheData, resetXmlCacheData, resetXslCacheData, setNodeSet, setShareResources, setSourceXML, setXMLId, setXMLString, setXMLTransformers, setXMLURL, setXSLId, setXSLParam, setXSLString, setXSLURL, setXmlAsync, setXmlBind
Methods Inherited From jsx3.gui.Block
getBackground, getBackgroundColor, getBorder, getCDFAttribute, getCSSOverride, getClassName, getColor, getCursor, getDimensions, getDisplay, getFontName, getFontSize, getFontWeight, getHeight, getIndex, getLeft, getMargin, getOverflow, getPadding, getRelativePosition, getTagName, getText, getTextAlign, getTip, getTop, getVisibility, getWidth, getZIndex, hideMask, paint, setBackground, setBackgroundColor, setBorder, setCDFAttribute, setCSSOverride, setClassName, setColor, setCursor, setDimensions, setDisplay, setFontName, setFontSize, setFontWeight, setHeight, setIndex, setLeft, setMargin, setOverflow, setPadding, setRelativePosition, setTagName, setText, setTextAlign, setTip, setTop, setVisibility, setWidth, setZIndex, showMask
Methods Inherited From jsx3.gui.Interactive
doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy
Methods Inherited From jsx3.gui.Painted
focus, getAbsolutePosition, getAttribute, getAttributes, getDynamicProperty, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty
Methods Inherited From jsx3.app.Model
adoptChild, doClone, findAncestor, findDescendants, getAncestorOfName, getAncestorOfType, getChild, getChildIndex, getChildren, getDescendantOfName, getDescendantsOfType, getFirstChild, getFirstChildOfType, getHelpId, getId, getLastChild, getLoadType, getMetaValue, getNS, getName, getNextSibling, getParent, getPersistence, getPreviousSibling, getServer, getUriResolver, insertBefore, load, loadAndCache, loadXML, onAfterAssemble, onAfterAttach, onBeforeAssemble, onChangeServer, onDestroy, onRemoveChild, onSetChild, onSetParent, removeChild, removeChildren, setChild, setHelpId, setLoadType, setMetaValue, setName, setPersistence, toString, toXML, toXMLDoc
Methods Inherited From jsx3.util.EventDispatcher
publish, subscribe, unsubscribe, unsubscribeAll
Methods Inherited From jsx3.lang.Object
clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf
Constructor Detail

init

void init(strName : String)
instance initializer

Parameters:

strNameunique name distinguishing this object from all other JSX GUI objects in the JSX application
Method Detail

getCDFId

void getCDFId()
Returns the CDF ID of the record to map to.

Overrides:

getCDFId in jsx3.gui.Block

read

void read(bRepaint : boolean, strRecordId : String)
Updates all mapped descendants with values from the source CDF Document

Parameters:

bRepaintif false no repaint will be applied when setting text or values
strRecordIdIf set, only those descendants that map to this specific CDF record will be updated.

redrawRecord

void redrawRecord(strRecordId : String, intAction : int)
No-op.

Parameters:

strRecordIdthe jsxid attribute of the data record to redraw.
intActionINSERT, UPDATE, or DELETE.

Overrides:

redrawRecord in jsx3.xml.CDF

setCDFId

void setCDFId(strCDFId : String)
Sets the CDF ID of the record to map to. Updates all mapped descendants with values from the newly created mapping.

Parameters:

strCDFIdIf not set, the CDF Id used by the nearest ancestor of type jsx3.gui.CDF will be used.

Overrides:

setCDFId in jsx3.gui.Block

write

void write()
Updates the source CDF document with values returned from mapped descendants