Namespace: loader

loader

IxLoader Class - Provides a handfull of Methods for loading Intrexx Application Pages in an output container, depending on the chosen api method or the settings passed to the loader method

Methods


<static> IxLoader.container(settings)

Loads an Intrexx Page in a Container (former embedded tooltip)

Parameters:
Name Type Description
settings LoaderContainerSettings
Returns:

status

Type
JQueryPromise
Examples
```
ix.loader.container({
  vm: "internal/system/vm/html/include/sample.vm",
  htmlTarget: [div]
});
```
```
ix.loader.container({
  vm: "internal/system/vm/html/include/sample.vm",
  htmlTarget: [div],
  ixApp: {
     guid: "C6F004594EEA424B2AACCD105181AD7F0660DF6D",
     pageGuid: "21A1FAA5770A6DFF0C43D0B7C6AB3812846B6F7C",
  },
  actionClose: function() {

  },
  data: {
      "rq_param1": "hello world"
  }
});
```

<static> IxLoader.isExternalUri(url)

helper method that gives information if a given url is to be considered as a portal intern url or not

Parameters:
Name Type Description
url string
Returns:

status

Type
boolean

<static> IxLoader.load(settings)

load an Intrexx Page into the current container. Note that to determine wht the current container is, an additional html element in the DOM is needed as a reference point

Parameters:
Name Type Description
settings LoadSettings
Returns:

status

Type
JQueryPromise
Example
```
ix.loader.load({
  ixApp: {
      guid: "C6F004594EEA424B2AACCD105181AD7F0660DF6D",
      pageGuid: "21A1FAA5770A6DFF0C43D0B7C6AB3812846B6F7C",
  },
  html: [element]
});
```

<static> IxLoader.loadJsLanguageConstants(options)

loads language constants

Parameters:
Name Type Description
options object
Returns:

status

Type
JQueryPromise

<static> IxLoader.loadStageUrl(strUrl)

loads a resource into the current stage. This Method should not be used anymore as it does not return a promise to wait for, but a boolean.

Parameters:
Name Type Description
strUrl string
Deprecated:
  • Yes
Returns:

satus

Type
boolean

<static> IxLoader.loadStageUrlAndInitializeMenu(url)

loads an url to the stage an sets the menu.

Parameters:
Name Type Description
url string
Returns:

status

Type
boolean

<static> IxLoader.loadStageUrlAndSetMenu(url)

loads an url to the stage and resets the menu

Parameters:
Name Type Description
url string
Returns:

status

Type
boolean

<static> IxLoader.popup(settings)

DEPRECATED Method for loading an Intrexx Page in a PopUp. Will be removed in further Intrexx Versions and now just redirects to IxLoader.tooltip

Parameters:
Name Type Description
settings PopupSettings
Deprecated:
  • Yes
Returns:

status

Type
JQueryPromise
Examples
```
ix.loader.popup({
  ixApp: {
      guid: "C6F004594EEA424B2AACCD105181AD7F0660DF6D",
      pageGuid: "21A1FAA5770A6DFF0C43D0B7C6AB3812846B6F7C",
  }
});
```
```
ix.loader.popup({
  ixApp: {
      guid: "C6F004594EEA424B2AACCD105181AD7F0660DF6D",
      pageGuid: "21A1FAA5770A6DFF0C43D0B7C6AB3812846B6F7C",
  },
  windowSettings: {
      width: 200,
      htmlTarget: [element]
  },
  data: {
      "rq_param1": "hello world"
  }
});
```

<static> IxLoader.process(settings)

loads a resource (Intrexx page, vm) and displays it in a target container, based on the passed settings object. Preferrably use the oter public methods like tooltip or stage

Parameters:
Name Type Description
settings IxLoaderProcessingSettings
Returns:

status

Type
JQueryPromise

<static> IxLoader.stage(settings)

load an Intrexx Page to the stage container (full page load)

Parameters:
Name Type Description
settings StageSettings
Returns:

status

Type
JQueryPromise
Example
```
ix.loader.stage({
  ixApp: {
      guid: "C6F004594EEA424B2AACCD105181AD7F0660DF6D",
      pageGuid: "21A1FAA5770A6DFF0C43D0B7C6AB3812846B6F7C",
  },
  data: {
      "rq_param1": "hello world"
  }
});
```

<static> IxLoader.StageLoaderSetTemplate(strQuerystring)

add an rq_template parameter to the given querystring

Parameters:
Name Type Description
strQuerystring string
Returns:

querystring

Type
string

<static> tooltip(settings)

Load intrexx page in a new tooltip popup.

Parameters:
Name Type Description
settings ix.loader~TooltipSettings
Returns:
Type
undefined
Examples
ix.loader.tooltip({
  ixApp: {
      guid: "C6F004594EEA424B2AACCD105181AD7F0660DF6D",
      pageGuid: "21A1FAA5770A6DFF0C43D0B7C6AB3812846B6F7C",
  }
});
ix.loader.tooltip({
  ixApp: {
      guid: "C6F004594EEA424B2AACCD105181AD7F0660DF6D",
      pageGuid: "21A1FAA5770A6DFF0C43D0B7C6AB3812846B6F7C",
  },
  windowSettings: {
      position: "embedded",
      htmlTarget: getElement("CONTAINER-GUID")
  },
  actionClose: function() {

  },
  data: {
      "rq_param1": "hello world"
  }
});
// full screen tooltip
ix.loader.tooltip({
 ixApp: {
     guid: "C6F004594EEA424B2AACCD105181AD7F0660DF6D",
     pageGuid: "21A1FAA5770A6DFF0C43D0B7C6AB3812846B6F7C",
 },
 windowSettings: {
     position: "window",
     alignment: "top_left",
     width: -1,
     height: -1,
     key: "fooBar"
 },
 actionClose: function() {
 },
 data: {
     "rq_param1": "hello world"
 }
});
// Close Tooltip
var oTooltipPopup = getTooltipByKey("fooBar");
oTooltipPopup.close();

Type Definitions


TooltipSettings

Type:
  • Object
Properties:
Name Type Argument Description
ixApp ix.loader~IntrexxApp <optional>

Target application.

vm String <optional>

Load static vtl file.

data Object <optional>

Data to be sent to the server. It will be appended to query string.

html HTMLElement <optional>

An element in the Document Object Model (DOM).

fup Object <optional>

Reference to a functional part

windowSettings ix.loader~TooltipWindowSettings <optional>
close Boolean <optional>

Close current window.

reloadByChange Boolean <optional>

Reload current window. Initiated actions: actMerge, actDelete.

actionClose function <optional>

A function to be called when the tooltip popup closes.

actionChange function <optional>

Callback function. Initiated actions: actMerge, actDelete. Overwrites default reloadByChange action.

actionBeforeLoad function <optional>

Callback function

actionAfterLoad function <optional>

Callback function

actionBeforeUnload function <optional>

Callback function

actionAfterUnload function <optional>

Callback function


TooltipWindowSettings

Type:
  • Object
Properties:
Name Type Argument Default Description
key String <optional>

Identifier.

title String <optional>

Tooltip Title.

closeByButton Boolean <optional>

Show tooltip close button.

closeByEsc Boolean <optional>

Close tooltip via ESC key.

closeByClick Boolean <optional>

Close tooltip on click anywhere outside the tooltip.

htmlTarget HTMLElement <optional>

An element in the Document Object Model (DOM).

position String <optional>

Tooltip positioning. Values: "mouse" | "element" (depends on htmlTarget) | "window" | "absolute" | "embedded" (depends on htmlTarget) | "modal"

fixed Boolean <optional>
true

Tooltip position relative to viewport. Tooltip positioning must be set to "window" or "modal".

alignment String <optional>

Alignment at current position. Possible values depends on position. e.g. "middle_center" | "above_right" | "below_right" | "below_center_left" | ...

keepVisible Boolean <optional>

Tooltip is kept in the visible region, whenever possible.

overflowBoundaries Object <optional>
{top: true, right: true, bottom: true, left: true}

Keep tooltip in visible range and check specific boundaries. Set true to check boundary.

className String <optional>

Tooltips style class.

width Number <optional>

Fix tooltip width in px.

widthUnit String <optional>
"px"

Tooltip width unit. "px" | "vw" viewport width (width: 1-100)

height Number <optional>

Fix tooltip height in px.

heightUnit String <optional>
"px"

Tooltip height unit. "px" | "vh" viewport height (height: 1-100)

offsetX Number <optional>

Horizontal tooltip tooltip offset in px.

offsetY Number <optional>

Vertical tooltip tooltip offset in px.

contentReplace Boolean <optional>
true

Tooltip removes content in target container. Requires Tooltip positioning "embedded".

contentRestore Boolean <optional>
false

Tooltip restores content of his target container on close. Requires Tooltip positioning "embedded".