Class: AmxNodeUpdateArguments

Oracle® Fusion Middleware JSDoc Reference for Oracle Mobile Application Framework
2.5.0.0.0
E90424-01

QuickNav

Methods


Non-public methods

adf.mf.api.amx.AmxNodeUpdateArguments extends adf.mf.api.AdfObject

Constructor

new AmxNodeUpdateArguments()

Internal object for the arguments to the markNodeForUpdate function

Methods

__addAmxNode(parentAmxNode, beforeAmxNodeId, amxNode, facet)

Adds an AMX node to be added to the hierarchy as a result of an embedded change
Parameters:
Name Type Description
parentAmxNode adf.mf.api.amx.AmxNode the parent AMX node to add to
beforeAmxNodeId string | null the ID to insert this node before or null to append
amxNode adf.mf.api.amx.AmxNode the node to add
facet string | null the facet to add the node to or null to add as a child

__getNodeChanges(amxNodeId) → {adf.mf.internal.amx.AmxNodeChanges|null}

Currently an internal method to get the node changes for a given node. This API may be changed in the future and therefore is currently marked as internal.
Parameters:
Name Type Description
amxNodeId string the AMX node ID
Returns:
the changes for the node or null if there aren't any
Type
adf.mf.internal.amx.AmxNodeChanges | null

__removeAmxNode(amxNode)

Adds an AMX node to be removed from the hierarchy as a result of an embedded change
Parameters:
Name Type Description
amxNode adf.mf.api.amx.AmxNode the node to remove

adopt(theRawObject)

Adopt the properties of another object as our own.
Parameters:
Name Type Description
theRawObject Object the other object
Inherited From:

cancel()

Request that the update be canceled. If the update has been queued, calling this function will prevent the update from being executed. This may be used if an asynchronous event has occurred while the update has been queued that makes the update undesirable. If the update has already run or is in progress this function will not have an effect.

clone() → {Object}

Returns a clone of this object. The default implementation is a shallow copy. Subclassers can override this method to implement a deep copy.
Inherited From:
Returns:
a new shallow copy of this object
Type
Object

createCallback(func) → {function}

Creates a function instance that will call back the passed in function with the current "this". This is extremely useful for creating callbacks.
Parameters:
Name Type Description
func function the function to proxy
Inherited From:
Returns:
the proxied function
Type
function

equals(object) → {boolean}

Indicates whether some other adf.mf.api.AdfObject is "equal to" this one. Method is equivalent to java ".equals()" method.
Parameters:
Name Type Description
object Object the object to compare with
Inherited From:
Returns:
whether the objects are "equal"
Type
boolean

getAffectedAttributes(amxNodeId) → {Object<string, boolean>}

Get an object representing the affected attributes for a given AmxNode ID.
Parameters:
Name Type Description
amxNodeId string the AmxNode ID
Returns:
an object with the changed attributes as keys and "true" as the value.
Type
Object<string, boolean>

getAffectedNodes() → {Array.<adf.mf.api.amx.AmxNode>}

Get an array of affected AmxNodes
Returns:
array of nodes
Type
Array.<adf.mf.api.amx.AmxNode>

getClass(otherInstance) → {Object}

Get the class for an object.
Parameters:
Name Type Description
otherInstance Object optional other object to use
Inherited From:
Returns:
the class of or null if the class cannot be found
Type
Object

getCollectionChanges(amxNodeId, attributeName) → {Object<string, adf.mf.api.amx.AmxCollectionChange>|undefined}

Get the collection changes for a given AmxNode and property
Parameters:
Name Type Description
amxNodeId string the AmxNode ID
attributeName string | null the name of the attribute of which to get the changes . Defaults to "value" if not provided
Returns:
an object with the attributes as keys and the collection change objects for the values. May be undefined if there are no changes for a given AmxNode
Type
Object<string, adf.mf.api.amx.AmxCollectionChange> | undefined

getTypeName() → {String}

Returns the type name for this instance
Inherited From:
Returns:
name of the Class
Type
String

isCanceled() → {boolean}

Check if the update has been canceled
Returns:
true if canceled
Type
boolean

setAffectedAttribute(amxNode, attributeName, attributeValue)

Mark an attribute of an AmxNode as affected
Parameters:
Name Type Description
amxNode adf.mf.api.amx.AmxNode the affected AmxNode
attributeName string the name of the affected attribute
attributeValue Object the new value of the attribute. Note this is only used if the embedded side is being used to maintain the node hierarchy

setCollectionChanges(amxNode, attributeName, collectionChanges)

Set the collection changes for a given AmxNode's attribute
Parameters:
Name Type Description
amxNode adf.mf.api.amx.AmxNode the AMX node (deprecated usage is to pass the node ID as a string. This will be supported for a limited time
attributeName string the name of the attribute that the collection had changes
collectionChanges adf.mf.api.amx.AmxCollectionChange the changes for the collection
Deprecated:
  • Please use addCollectionChanges instead

    toDebugString() → {String}

    Get a debug string representation of this object instance. It is not guaranteed to be unique or of a standard format.
    Inherited From:
    Returns:
    a debug string representation of this object instance
    Type
    String

    toString() → {String}

    Get a string representation of this object instance. It is not guaranteed to be unique or interesting.
    Inherited From:
    Returns:
    a string representation of this object instance
    Type
    String

    Non-public Methods

    <protected> GetLazyArrayProperty(key, createIfNonexistent, otherInstance) → {Object}

    Returns the specified array property. If createIfNonexistent is true and the property doesn't exist, it will be created, and returned.
    Parameters:
    Name Type Description
    key Object the key for the property
    createIfNonexistent boolean true if a new empty Array should be created and associated
    otherInstance Array another object to use instead of this object
    Inherited From:
    Returns:
    the property value associated with the given key
    Type
    Object

    <protected> GetLazyMapProperty(key, createIfNonexistent, otherInstance) → {Object}

    Returns the specified Map property value. If createIfNonexistent is true and the property doesn't exist, an empty Object will be created, and returned.
    Parameters:
    Name Type Description
    key Object the key for the property
    createIfNonexistent boolean true if a new empty Object should be created and associated
    otherInstance Object another object to use instead of this object
    Inherited From:
    Returns:
    the property value associated with the given key
    Type
    Object