Class sap.ushell.renderers.fiori2.RendererModule: sap/ushell/renderers/fiori2/Renderer

Creates an Action Button in Fiori launchpad, in the given launchpad states.
The button will be displayed in the user actions menu, that is opened from the user button in the shell header.
Example:

 sap.ushell.Container.getRenderer("fiori2").addActionButton("sap.m.Button", {id: "testBtn2", text: "test button"}, true, true);

Adds the given sap.ui.core.Control to the EndUserFeedback dialog.
The EndUserFeedback dialog is opened via the user actions menu in the Fiori Launchpad shell header.

Creates a FloatingActionButton in Fiori launchpad, in the given launchpad states.
The FloatingActionButton is rendered in the bottom right corner of the shell.
Example:

 sap.ushell.Container.getRenderer("fiori2").addFloatingActionButton("sap.ushell.ui.shell.ShellFloatingAction", {id: "testBtn"}, true, true);

Creates and displays one or more HeaderItem controls in Fiori launchpad, in the given launchpad states.
The HeaderItem will be displayed in the right side of the Fiori Launchpad shell header.
Example:

 sap.ushell.Container.getRenderer("fiori2").addHeaderEndItem("sap.ushell.ui.shell.ShellHeadItem", {id: "testBtn"}, true, true);

Creates and displays an item in the header of Fiori launchpad, in the given launchpad states.
The new header item will be displayed on the left-hand side of the Fiori Launchpad shell header, according to the given display parameters.
The new header item will be added to the right of any existing header items. The header can contain a maximum of three header items.

Example:

var oRenderer = sap.ushell.Container.getRenderer("fiori2");
oRenderer.addHeaderItem("sap.ushell.ui.shell.ShellHeadItem", {id: "testBtn"}, true, true);

Creates the Left Pane content in Fiori launchpad, in the given launchpad states.
Example:

 sap.ushell.Container.getRenderer("fiori2").addLeftPaneContent("sap.m.Button", {id: "testBtn", text: "Test Button"}, true, true);

Creates and displays a sub header control in Fiori launchpad, in the given launchpad states.
The new control is displayed in FLP UI according to the given display parameters.
If a sub header already exists, the new created one will replace the existing one.

Example:

var oRenderer = sap.ushell.Container.getRenderer("fiori2");
oRenderer.addSubHeader("sap.m.Bar", {id: "testBar", contentLeft: [new sap.m.Button({text: "Test SubHeader Button",
     press: function () {
     sap.m.MessageToast.show("Pressed");
     }
 })
]}, true, true);

Creates a ToolAreaItem in Fiori Launchpad and adds it to the Tool Area, in the given launchpad states.
If no items are added to the Tool Area, it will not be displayed.
Once an item is added, the Tool Area is rendered on the left side on the Fiori Launchpad shell.

Example:

sap.ushell.Container.getRenderer("fiori2").addToolAreaItem({
             id: "testButton",
             icon: "sap-icon://documents",
             expandable: true,
             press: function (evt) {
                window.alert("Press" );
               },
            expand: function (evt) {
                // This function will be called on the press event of the "expand" button. The result of "expand" event in the UI must be determined by the developer
                window.alert("Expand" );
               }
          }, true, false, ["home"]);

Adds an entry to the User Preferences dialog box including the UI control that appears when the user clicks the new entry,
and handling of User Preferences actions such as SAVE and CANCEL.

Example:

var oRenderer = sap.ushell.Container.getRenderer("fiori2");
var oEntry = {
  title: "title",
  value: function() {
      return jQuery.Deferred().resolve("entryTitleToBeDisplayed");
  },
  content: function() {
      return jQuery.Deferred().resolve(new sap.m.Button("userPrefEntryButton", {text: "Button"}));
  },
  onSave: function() {
      return jQuery.Deferred().resolve();
  }
  };
oRenderer.addUserPreferencesEntry(oEntry);   

This method returns the current state of the Viewport Container control.

Hide the given Action Button from Fiori Launchpad, in the given launchpad states. The removed button will not be destroyed.

This API is meant to be used for implementing custom elements in the SAP Fiori launchpad. We do not recommend using it on a standard launchpad element, as this may interfere with the standard launchpad functionality.

Hide the given sap.ushell.ui.shell.ShellFloatingAction from Fiori Launchpad, in the given launchpad states. The removed control will not be destroyed.

This API is meant to be used for implementing custom elements in the SAP Fiori launchpad. We do not recommend using it on a standard launchpad element, as this may interfere with the standard launchpad functionality.

Hide the given sap.ushell.ui.shell.ShellHeadItem from Fiori Launchpad, in the given launchpad states. The removed control will not be destroyed.

This API is meant to be used for implementing custom elements in the SAP Fiori launchpad. We do not recommend using it on a standard launchpad element, as this may interfere with the standard launchpad functionality.

Hide the given sap.ushell.ui.shell.ShellHeadItem from Fiori Launchpad, in the given launchpad states. The removed control will not be destroyed.

This API is meant to be used for implementing custom elements in the SAP Fiori launchpad. We do not recommend using it on a standard launchpad element, as this may interfere with the standard launchpad functionality.

Hide the given control from Fiori Launchpad, in the given launchpad states. The removed control will not be destroyed.

This API is meant to be used for implementing custom elements in the SAP Fiori launchpad. We do not recommend using it on a standard launchpad element, as this may interfere with the standard launchpad functionality.

Hide the given control from the Fiori Launchpad sub header, in the given launchpad states. The removed control will not be destroyed.

This API is meant to be used for implementing custom elements in the SAP Fiori launchpad. We do not recommend using it on a standard launchpad element, as this may interfere with the standard launchpad functionality.

If exists, this method will remove the footer from the Fiori Launchpad.

This API is meant to be used for implementing custom elements in the SAP Fiori launchpad. We do not recommend using it on a standard launchpad element, as this may interfere with the standard launchpad functionality.

Remove the given Tool Area Item from Fiori Launchpad, in the given launchpad states.

This API is meant to be used for implementing custom elements in the SAP Fiori launchpad. We do not recommend using it on a standard launchpad element, as this may interfere with the standard launchpad functionality.

Displays the given sap.m.Bar as the footer of the Fiori launchpad shell.
The footer will be displayed in all states.

Example:

 var bar = new sap.m.Bar({contentLeft: [new sap.m.Button({text: "Test Footer Button",
press: function () {
sap.m.MessageToast.show("Pressed");
}})
]});
 var renderer = sap.ushell.Container.getRenderer("fiori2");
 renderer.setFooter(bar);

Sets the title in the Fiori Launchpad shell header.

Sets the header visibility accrding to the given value and shell states.
(see sap.ushell.renderers.fiori2.renderer.LaunchpadState).

Example:

var oRenderer = sap.ushell.Container.getRenderer("fiori2");
oRenderer.setHeaderVisibility(false, false, ["home", "app"]);

Sets the visibility of the left pane in the Fiori Launchpad shell, in the given launchpad state

Displays Buttons on the user actions menu in the Fiori launchpad shell, in the given launchpad states (see sap.ushell.renderers.fiori2.renderer.LaunchpadState).
If no launchpad state is provided the content is displayed in all states.
The user actions menu is opened via the button on the right hand side of the shell header.

Example:

  var button1 = new sap.m.Button();
  var renderer = sap.ushell.Container.getRenderer("fiori2");
  renderer.showActionButton([button1.getId()], false, ["home", "app"]);
  

Displays FloatingActionButton on the bottom right corner of the Fiori launchpad, in the given launchpad states. The FloatingActionButton is rendered in the bottom right corner of the shell.
(see sap.ushell.renderers.fiori2.renderer.LaunchpadState).
If no launchpad state is provided the content is displayed in all states.

Example:

  var button1 = new sap.ushell.ui.shell.ShellFloatingAction();
  var renderer = sap.ushell.Container.getRenderer("fiori2");
  renderer.showFloatingActionButton([button1.getId()], true);
  

Displays HeaderItems on the right side of the Fiori launchpad shell header, in the given launchpad states (see sap.ushell.renderers.fiori2.renderer.LaunchpadState).
If no launchpad state is provided the content is displayed in all states.
The shell header can display the user HeaderItem, and just one more HeaderItem.
If this method is called when the right side of the header is full, this method will not do anything.

Example:

  var button1 = new sap.ushell.ui.shell.ShellHeadItem();
  var renderer = sap.ushell.Container.getRenderer("fiori2");
  renderer.showHeaderEndItem ([button1.getId()], false, ["home", "app"]);
  

Creates and displays one or more HeaderItem controls according to the given control IDs and Shell states
(see sap.ushell.renderers.fiori2.renderer.LaunchpadState).

The HeaderItem controls will be displayed on the left side of the Fiori Launchpad shell header according to the given display parameters.
There can be up to three header items. If the number of existing header items plus the given ones exceeds 3, then the operation fails and no new header items are created.

Example:

var button1 = new sap.ushell.ui.shell.ShellHeadItem();
var button2 = new sap.ushell.ui.shell.ShellHeadItem();
var renderer = sap.ushell.Container.getRenderer("fiori2");
renderer.showHeaderItem ([button1.getId(), button2.getId()], false, ["home", "app"]);

Displays one or more sub header controls according to the given control IDs and shell states.
(see sap.ushell.renderers.fiori2.renderer.LaunchpadState).

A sub header is placed in a container, located directly below the main Fiori launchpad shell header.

Example:

var bar = new sap.m.Bar({id: "testBar", contentLeft: [new sap.m.Button({text: "Test SubHeader Button",
press: function () {
sap.m.MessageToast.show("Pressed");
}})
]});
var oRenderer = sap.ushell.Container.getRenderer("fiori2");
oRenderer.showSubHeader([bar.getId()], false, ["home", "app"]);

Sets the ToolArea visibility

Displays ToolAreaItem on the left side of the Fiori launchpad shell, in the given launchpad states (see sap.ushell.renderers.fiori2.renderer.LaunchpadState).
If no launchpad state is provided the content is displayed in all states.

Example:

  var button1 = new sap.ushell.ui.shell.ToolAreaItem();
  var renderer = sap.ushell.Container.getRenderer("fiori2");
  renderer.showToolAreaItem(button1.getId(), false, ["home", "app"]);