Package com.adobe.xfa.localeset

Class LocaleSetModel

java.lang.Object

com.adobe.xfa.Obj

com.adobe.xfa.Node

com.adobe.xfa.Element

com.adobe.xfa.Model

com.adobe.xfa.localeset.LocaleSetModel

All Implemented Interfaces:

Element.DualDomNode, Peer

public final class LocaleSetModel
extends Model

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

Nested Class Summary

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

Model.DualDomModel, Model.Publisher

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

Element.DualDomNode, Element.ReplaceContent

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

Node.ChangeLogger

Field Summary

Fields inherited from class com.adobe.xfa.Element

AttrIsDefault, AttrIsFragment, AttrIsTransient, CREATEACTION

Fields inherited from class com.adobe.xfa.Node

CREATE_ALWAYS_NEW, CREATE_IF_NOT_EXIST, CREATE_MUST_NOT_EXIST, CREATE_REPLACE, gsXFANamespacePrefix

Fields inherited from interface com.adobe.xfa.ut.Peer

ATTR_CHANGED, CHILD_ADDED, CHILD_REMOVED, DESCENDENT_ADDED, DESCENDENT_ATTR_CHANGED, DESCENDENT_REMOVED, DESCENDENT_VALUE_CHANGED, PARENT_CHANGED, PERMS_LOCK_CLEARED, PERMS_LOCK_SET, PROTO_ATTR_CHANGED, PROTO_CHILD_ADDED, PROTO_CHILD_REMOVED, PROTO_DESCENDENT_ADDED, PROTO_DESCENDENT_ATTR_CHANGED, PROTO_DESCENDENT_REMOVED, PROTO_DESCENDENT_VALUE_CHANGED, PROTO_VALUE_CHANGED, UPDATED, VALUE_CHANGED

Constructor Summary

Constructors

Constructor	Description
LocaleSetModel(Element parent, Node prevSibling)	Default Constructor.

Method Summary

Modifier and Type	Method	Description
Node	createNode(int eTag, Element parent, java.lang.String aName, java.lang.String aNS, boolean bDoVersionCheck)	Create an element with the given tag, parent, name and uri.
java.lang.String	getBaseNS()
java.lang.String	getHeadNS()
int	getHeadVersion()
static LocaleSetModel	getLocaleSetModel(AppModel appModel, boolean bCreateIfNotFound)	Gets the locale set model held within an XFA DOM hierarchy.
java.lang.String	getNS()	Gets this element's namespace.
boolean	isVersionCompatible(int nVersion, int nTargetVersion)
static void	loadLocalesFromConfig(Node oContext)
static java.lang.String	localeSetNS()	Namespace
void	refreshLocales()	Refresh the XFA API's runtime locale data from this model's localeSet.
static boolean	setLocaleSetModel(AppModel oAppModel, Element oNode)	Convenience method to update the LocaleSetModel held within the DOM hierarchy.

Methods inherited from class com.adobe.xfa.Model

addErrorList, addUseHRefNode, addUseNode, addXMLLoadErrorContext, allowUpdates, checkforCompatibleNS, clearErrorList, clone, createElement, createElement, createElement, createElement, createElement, createTextNode, createTextNode, doAttributeCleanup, getAliasNode, getAppModel, getAppModelIsTransient, getCachedLocale, getContext, getCurrentVersion, getDelta, getDeltas, getDocument, getErrorContextList, getErrorList, getEventManager, getGenerator, getIDValueMap, getLegacySetting, getLogMessenger, getName, getNeedsNSNormalize, getNode, getOriginalVersion, getOriginalVersionNode, getOriginalXFAVersion, getProtoList, getSchema, getScriptTable, getSourceBelow, getVersion, getXmlPeer, isCompatibleNS, isContainer, isLoading, loadNode, loadRootAttributes, loadSpecialAttribute, loadSpecialNode, modelCleanup, nodeCleanup, normalizeNameSpaces, normalizeNameSpaces, normalizeNameSpaces, preLoadNode, preSave, publish, ready, remapTag, remove, removeLastError, removeReferences, resolveNodes, resolveProtos, serialize, setAliasNode, setAppModel, setAppModelIsTransient, setContext, setCurrentVersion, setDOMProperties, setIDValueMap, setName, setNeedsNSNormalize, setOriginalXFAVersion, setXmlPeer, shortCutName, validateUsage, validateUsageFailedIsFatal, willDirtyDoc, willDirtyDoc

Methods inherited from class com.adobe.xfa.Element

appendChild, appendChild, appendPI, appendPI, assignNode, clone, connectPeerToDocument, constructKey, constructKeys, copyContent, defaultAttribute, defaultElement, defaultElement, establishID, evaluate, explodeQName, findAttr, findSchemaAttr, foundBadAttribute, foundBadAttribute, getAll, getAtom, getAttr, getAttribute, getAttribute, getAttributeByName, getAttrIndex, getAttrName, getAttrNS, getAttrProp, getAttrQName, getAttrVal, getChildReln, getClassAll, getClassIndex, getClassName, getDeltas, getElement, getElement, getElementClass, getElementLocal, getEnum, getEnum, getEventTable, getFirstXFAChild, getFirstXMLChild, getID, getIndex, getInheritedNS, getInstalledLocale, getIsNull, getLastXMLChild, getLineNumber, getLocalName, getModel, getNode, getNodes, getNodeSchema, getNumAttrs, getOneOfChild, getOneOfChild, getPI, getPI, getPrefix, getProperty, getProperty, getSaveXMLSaveTransient, getSchemaType, getScriptMethodInfo, getSibling, getText, getXFAChild, getXMLChild, getXMLName, getXPath, getXsiNilAttribute, inhibitPrettyPrint, inhibitPrettyPrint, insertChild, isFragment, isHidden, isHidden, isIndexed, isInstalledLocaleAmbient, isLeaf, isNameSpaceAttr, isPropertySpecified, isPropertySpecified, isPropertyValid, isSpecified, isSpecified, isSpecified, isTransient, isTransparent, isValidAttr, isValidChild, isValidElement, loadXML, loadXML, makeDefault, makeNonDefault, newAttribute, optimizeNameSpace, peekAttribute, peekElement, peekOneOfChild, peekProperty, peekProperty, postSave, privateSetName, processTextChildrenDuringParse, removeAttr, removeAttr, removeChild, removePI, removePI, removeWhiteSpace, removeXsiNilAttribute, replaceChild, resetPostLoadXML, resolveAndEnumerateChildren, resolveNodeCreate, resolvePrefix, saveFilteredXML, saveXML, saveXML, setAttribute, setAttribute, setAttribute, setAttribute, setAttrProp, setDefaultFlag, setElement, setIsDataWindowRoot, setIsIndexed, setLineNumber, setLocalName, setModel, setNS, setOneOfChild, setProperty, setProperty, setQName, setSaveXMLSaveTransient, setTransparent, setXMLName, setXsiNilAttribute, updateFromPeer

Methods inherited from class com.adobe.xfa.Node

checkAncestorPerms, checkDescendentPerms, checkPerms, cleanDirtyFlags, compareVersions, getData, getFirstXMLChildElement, getLocked, getNextXFASibling, getNextXMLSibling, getNextXMLSiblingElement, getNodeAsXML, getOwnerDocument, getPIAsXML, getPIName, getPreviousXMLSibling, getPrivateName, getPropName, getSOMExpression, getSOMExpression, getSomName, getUniqueSOMName, getWillDirty, getXFAChildCount, getXFAParent, getXfaPeer, getXMLChildCount, getXMLParent, hasChanged, isDefault, isDirty, isMapped, isPermsLockSet, isTransient, locateChildByClass, locateChildByName, logValueChangeHelper, notifyPeers, performSOMAssignment, resolveNode, resolveNode, resolveNode, resolveNodes, sendMessenge, setDirty, setDocument, setLocked, setMapped, setPermsLock, setPrivateName, setWillDirty, setXfaPeer, unLock, validateSchema

Methods inherited from class com.adobe.xfa.Obj

addPeer, addPeeredNode, clearPeers, deafen, getClassAtom, getClassTag, getPeer, getScriptProperty, getScriptThis, invokeFunction, isDeaf, isMute, isSameClass, isSameClass, isSameClass, mute, peerRemoved, removePeer, removePeeredNode, setClass, setClassTag, setScriptProperty, unDeafen, unMute

Methods inherited from class java.lang.Object

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

Constructor Detail

LocaleSetModel

public LocaleSetModel(Element parent,
                      Node prevSibling)

Default Constructor.

Method Detail

createNode

public Node createNode(int eTag,
                       Element parent,
                       java.lang.String aName,
                       java.lang.String aNS,
                       boolean bDoVersionCheck)

Description copied from class: Model

Create an element with the given tag, parent, name and uri.

Specified by:

createNode in class Model

Parameters:

eTag - the element's tag.

parent - the element's parent.

aName - the element's name.

aNS - the element's namespace.

bDoVersionCheck - check the element's version.

Returns:

a new element.

See Also:

Model.createNode(int, Element, String, String, boolean)

getBaseNS

public java.lang.String getBaseNS()

Specified by:

getBaseNS in class Model

See Also:

Model.getBaseNS()

getHeadNS

public java.lang.String getHeadNS()

Specified by:

getHeadNS in class Model

getLocaleSetModel

public static LocaleSetModel getLocaleSetModel(AppModel appModel,
                                               boolean bCreateIfNotFound)

Gets the locale set model held within an XFA DOM hierarchy.

Parameters:

appModel - the application model.

bCreateIfNotFound - when set, create a model if necessary.

Returns:

the locale set model or null if none found.

localeSetNS

public static java.lang.String localeSetNS()

Namespace

Returns:

The localeSet namespace URI string.

setLocaleSetModel

public static boolean setLocaleSetModel(AppModel oAppModel,
                                        Element oNode)

Convenience method to update the LocaleSetModel held within the DOM hierarchy. Search the given root node for the locale attribute off subform and field nodes. Augment the locale set model with the data of all new locales found from this search.

Parameters:

oAppModel - - the application model.

oNode - - the root node of the template model.

Returns:

boolean true upon success and false otherwise.

refreshLocales

public void refreshLocales()

Refresh the XFA API's runtime locale data from this model's localeSet. Typically the localeSet will contain locales and/or locale data that is different from LcData's static store.

loadLocalesFromConfig

public static void loadLocalesFromConfig(Node oContext)

getHeadVersion

public int getHeadVersion()

Overrides:

getHeadVersion in class Model

getNS

public java.lang.String getNS()

Description copied from class: Element

Gets this element's namespace.

Overrides:

getNS in class Model

Returns:

the namespace URI.

See Also:

Element.getNS()

isVersionCompatible

public boolean isVersionCompatible(int nVersion,
                                   int nTargetVersion)

Overrides:

isVersionCompatible in class Model