com.adobe.xfa.configuration
Class ConfigurationModel

java.lang.Object
  com.adobe.xfa.Obj
      com.adobe.xfa.Node
          com.adobe.xfa.Element
              com.adobe.xfa.Model
                  com.adobe.xfa.configuration.ConfigurationModel

public final class ConfigurationModel
extends Model

A class to model the collection of all XFA nodes that make up form config.

Nested Class Summary

Nested classes/interfaces inherited from class com.adobe.xfa.Node

Node.ChangeLogger

Field Summary

Fields inherited from class com.adobe.xfa.Node

CREATE_ALWAYS_NEW, CREATE_IF_NOT_EXIST, CREATE_MUST_NOT_EXIST, CREATE_REPLACE

Method Summary

static ConfigurationModel	getConfigurationModel(AppModel appModel, boolean bCreateIfNotFound) Gets the configuration model held within an XFA DOM hierarchy.
Attribute	getConfigValue(java.lang.String sSOM, BooleanHolder isDefault) Gets the value of a configuration value node.
boolean	getConfigValue(java.lang.String sSOM, java.lang.StringBuilder sValue) Gets the value of a configuration value node.

Methods inherited from class com.adobe.xfa.Model

clearErrorList, createElement, createElement, createElement, createTextNode, getCurrentVersion, getDocument, getErrorContextList, getErrorList, normalizeNameSpaces, resolveNodes

Methods inherited from class com.adobe.xfa.Element

appendChild, assignNode, getAttr, getAttribute, getElement, getFirstXFAChild, getFirstXMLChild, getInstalledLocale, getLastXMLChild, getModel, getName, getNodes, getNS, getNumAttrs, getPrefix, getText, getXFAChild, getXMLChild, isInstalledLocaleAmbient, loadXML, saveXML, setAttribute, setAttribute, setAttribute, setLocalName, setName, setNS, setQName

Methods inherited from class com.adobe.xfa.Node

checkAncestorPerms, checkDescendentPerms, checkPerms, cleanDirtyFlags, compareVersions, getData, getDynamicScriptProp, getNextXFASibling, getNextXMLSibling, getOwnerDocument, getPreviousXMLSibling, getSOMExpression, getXFAChildCount, getXFAParent, getXMLChildCount, getXMLParent, hasChanged, remove, resolveNode, resolveNode, resolveNodes, setNextXMLSibling, setPermsLock, setXMLParent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getConfigurationModel

public static ConfigurationModel getConfigurationModel(AppModel appModel,
                                                       boolean bCreateIfNotFound)

Gets the configuration model held within an XFA DOM hierarchy.

Parameters:

appModel - the application model.

bCreateIfNotFound - when set, create a model if necessary.

Returns:

the configuration model or null if none found.

getConfigValue

public Attribute getConfigValue(java.lang.String sSOM,
                                BooleanHolder isDefault)

Gets the value of a configuration value node.

If the node doesn't exist, the default value will be returned.

Parameters:

sSOM - A SOM expression specifying the configuration value node.

isDefault - a scalar which is set to true if the node exists, and false if the node does not exist and the value returned is a default value.

Returns:

the retrieved attribute.

getConfigValue

public boolean getConfigValue(java.lang.String sSOM,
                              java.lang.StringBuilder sValue)

Gets the value of a configuration value node.

If the node doesn't exist, the default value will be returned.

Parameters:

sSOM - A SOM expression specifying the configuration value node.

sValue - The retrieved value.

Returns:

true if the node exists, and false if the node does not exist and the value returned is a default value.