JSDoc: Global

Fields

oj

Global exported Oracle JET namespace

Properties:

Name	Type	Description
`version`	String	JET version number
`build`	String	JET build number
`revision`	String	JET source code revision number

Source:

src/main/javascript/oracle/oj/ojcore/oj-namespace.js, line 39

Methods

_createHelpIfNeeded()

Create help if needed

Source:

src/main/javascript/oracle/oj/ojeditablevalue/ojlabel.js, line 351

_needsDescribedBySpan() → {undefined}

Source:

src/main/javascript/oracle/oj/ojeditablevalue/ojlabel.js, line 770

Returns:

Type: undefined

_needsHelpIcon() → {boolean}

Source:

src/main/javascript/oracle/oj/ojeditablevalue/ojlabel.js, line 780

Returns:

Type: boolean

_removeHelpDefPopup() → {undefined}

removes the help def popup dom and variables

Source:

src/main/javascript/oracle/oj/ojeditablevalue/ojlabel.js, line 726

Returns:

Type: undefined

ajax() → {Object}

Master Ajax entry point for all oj.Model and oj.Collection server interactions, when they are using the default sync implementations. oj.ajax passes through to jQuery ajax by default. See http://api.jquery.com/jquery.ajax/ for expected parameters and return value.

Source:

src/main/javascript/oracle/oj/ojmodel/Model.js, line 1641

Returns:

xhr object

Type: Object

check_move()

Checks the prepared_move object, and returns true if the move is acceptable, else false.

Source:

src/main/javascript/oracle/oj/ojtree/ojtree.js, line 3129

getSubIdByNode(node) → {Object|null}

Returns the subId locator for the given child DOM node. Invoked by widget

Parameters:

Name	Type	Description
`node`	Element	child DOM node

Source:

src/main/javascript/oracle/oj/ojslider/ojslider.js, line 1904

Returns:

The subId for the DOM node, or null when none is found.

Type: Object | null

sync(method, model, options) → {Object}

Master server access method for all models and collections. Replace oj.sync with a new implementation to customize all oj.Model and oj.Collection server interactions

Parameters:

Name	Type	Argument	Description
`method`	string		"create", "read", "update", "patch", or "delete"
`model`	Object		Model (or Collection to be read) to be read/saved/deleted/created
`options`	Object	<optional>	to control sync success: called if sync succeeds error: called if sync fails others are passed to jQuery Options that would normally be passed to a customURL callback are also included

Source:

src/main/javascript/oracle/oj/ojmodel/Model.js, line 1576

Returns:

xhr object

Type: Object

Non-public Methods

<protected> _GetFirstBracketedString(subId) → {string}

Returns the first bracketed substring in the specified string.

Parameters:

Name	Type	Description
`subId`	string

Source:

src/main/javascript/oracle/oj/ojdvt-base/ojdvt-base.js, line 630

Returns:

Type: string

<protected> _GetFirstIndex(subId) → {number}

Converts a string containing a single index in the form '[index]' into the numerical index.

Parameters:

Name	Type	Description
`subId`	string

Source:

src/main/javascript/oracle/oj/ojdvt-base/ojdvt-base.js, line 619

Returns:

Type: number

<protected> _GetIndexPath(subId) → {Array}

Converts a string containing indices in the form '[index0][index1]...[indexN]' to an array of indices.

Parameters:

Name	Type	Description
`subId`	string

Source:

src/main/javascript/oracle/oj/ojdvt-base/ojdvt-base.js, line 600

Returns:

The resulting array to be used for locator indexPath.

Type: Array

<protected> _GetStringFromIndexPath(indexPath) → {string}

Converts an indexPath array to a string of the form '[index0][index1]...[indexN]'.

Parameters:

Name	Type	Description
`indexPath`	Array

Source:

src/main/javascript/oracle/oj/ojdvt-base/ojdvt-base.js, line 585

Returns:

The resulting string.

Type: string