Action Sheet Button 2.0 - SCN Design Studio Community

VISIBLE PROPERTIES

Name	Description	Group	Default	Visible
buttonType [String]	Type Type	Display	Default	true
icon [String]	Icon Icon	Display	sap-icon://menu2	true
items [String]	Items Items	Display	[{"parentKey":"ROOT","key":"ELEMENT","leaf":false,"text":"First Element","icon":"sap-icon://accept"} ... truncated	true
placement [String]	Placement Placement	Display	Auto	true
text [String]	Title Title	Display		true

VISIBLE EVENTS

Name	Description	Group	Default	Visible
onPopoverSelect [ScriptText]	On Select On Select	Events		true

FUNCTIONS LIST

Name	Parameters	Return
addItem [details]	key, text, icon	void
cleanAllItems [details]		String
getButtonType [details]		org_scn_community_shared_ButtonTypeEnumfield
getButtonTypeAsString [details]		String
getIcon [details]		String
getItemAtIndex [details]	index0based	String
getItemIcon [details]	key	String
getItemText [details]	key	String
getItemsAsJSON [details]		String
getPlacement [details]		org_scn_community_shared_PlacementEnumfield
getPlacementAsString [details]		String
getSelectedItem [details]		String
getSelectedKey [details]		String
getText [details]		String
insertItem [details]	insertionIndex0based, key, text, icon	void
removeItem [details]	key	void
setButtonType [details]	buttonType	void
setButtonTypeByString [details]	buttonType	void
setIcon [details]	icon	void
setItemIcon [details]	key, icon	void
setItemIcons [details]	keys, separator, icon	void
setItemText [details]	key, text	void
setItemTexts [details]	keys, separator, text	void
setPlacement [details]	placement	void
setPlacementByString [details]	placement	void
setText [details]	text	void
updateItem [details]	key, text, icon	void

HIDDEN (TECHNICAL) PROPERTIES

Name	Description	Group	Default	Visible
selectedItem [String]	Selected Item Selected Item	Display		false
selectedKey [String]	Selected Key Selected Key	Display		false

FUNCTIONS IN DETAIL

void
addItem

Adds a root element containing key [String], text [String], icon [String].

You want to add 2 root elements

ACTIONSHEETBUTTON.addItem(key [String], text [String], icon [String]);
ACTIONSHEETBUTTON.addItem(key [String], text [String], icon [String]);

Name	Type	Help
key	String	Unique Property Key
text	String	Text
icon	String	Icon

Source Code

String
cleanAllItems

Cleans All Items

Source Code

this.items = "[]";

org_scn_community_shared_ButtonTypeEnumfield
getButtonType

Gets Type Property as Choice Option

Source Code

return this.buttonType;

String
getButtonTypeAsString

Gets Type Property as String

Source Code

return this.buttonType;

String
getIcon

Gets Icon Property

Source Code

return this.icon;

String
getItemAtIndex

Returns Key at given Index

Name	Type	Help
index0based	int	Index to pick the key

Source Code

if (this.items === undefined || this.items === "" || this.items === "<delete>"){
      this.items = "[]";
    }

    var elementsJson = JSON.parse(this.items);

    for (var i = 0; i < elementsJson.length ; i++){
      if (index0based == i) {
        return elementsJson[i].key;
      }
    }

    return "";

String
getItemIcon

Returns value of Icon for Item Key

Name	Type	Help
key	String

Source Code

if (this.items === undefined || this.items === "" || this.items === "<delete>"){
      return;
    }

    var elementsJson = JSON.parse(this.items);

    var value = "";
    // loop and find and update
    for (var i = 0; i < elementsJson.length ; i++){
      if (elementsJson[i].key == key) {
        value = elementsJson[i].icon;
        break;
      }
    }

    return value;

String
getItemText

Returns value of Text for Item Key

Name	Type	Help
key	String

Source Code

if (this.items === undefined || this.items === "" || this.items === "<delete>"){
      return;
    }

    var elementsJson = JSON.parse(this.items);

    var value = "";
    // loop and find and update
    for (var i = 0; i < elementsJson.length ; i++){
      if (elementsJson[i].key == key) {
        value = elementsJson[i].text;
        break;
      }
    }

    return value;

String
getItemsAsJSON

Gets Items As JSON String

Source Code

var jsonObject = JSON.parse(this.items);
return JSON.stringify(jsonObject, null, 4);

org_scn_community_shared_PlacementEnumfield
getPlacement

Gets Placement Property as Choice Option

Source Code

return this.placement;

String
getPlacementAsString

Gets Placement Property as String

Source Code

return this.placement;

String
getSelectedItem

Gets Selected Item Property

Source Code

return this.selectedItem;

String
getSelectedKey

Gets Selected Key Property

Source Code

return this.selectedKey;

String
getText

Gets Title Property

Source Code

return this.text;

void
insertItem

Insert a root element by index.

You want to insert a root element

ACTIONSHEETBUTTON.insertItem(index [int], key [String], text [String], icon [String]);

Name	Type	Help
insertionIndex0based	int	Index to Insert (0-based)
key	String	Unique Property Key
text	String	Text
icon	String	Icon

Source Code

if (this.items === undefined || this.items === "" || this.items === "<delete>"){
      this.items = "[]";
    }

    var elementsJson = JSON.parse(this.items);
    var newElementsJson = [];

    var itemDef = {
      leaf:true,
      key:key,
      text:text,
      icon:icon
    };

    for (var i = 0; i < elementsJson.length ; i++){
      if (i == insertionIndex0based) {
        newElementsJson.push(itemDef);
      }

      newElementsJson.push(elementsJson[i]);
    }

    this.items = JSON.stringify(newElementsJson);

void
removeItem

Removes a root element by key.

You want to remove root element

ACTIONSHEETBUTTON.removeItem(String key);

Name	Type	Help
key	String

Source Code

if (this.items === undefined || this.items === "" || this.items === "<delete>"){
      this.items = "[]";
    }

    var elementsJson = JSON.parse(this.items);

    var alreadyFound = false;
    for (var i = 0; i < elementsJson.length ; i++){
      if (elementsJson[i].key == key) {
        elementsJson.splice(i,1);
        break;
      }
    }

    // remove all items with this parent
    for (var i = elementsJson.length - 1; i >= 0; i--){
      if (elementsJson[i].parentKey == key) {
        elementsJson.splice(i,1);
      }
    }

    this.items = JSON.stringify(elementsJson);

void
setButtonType

Sets Type Property by Choice Option

Name	Type	Help
buttonType	org_scn_community_shared_ButtonTypeEnumfield	Type

Source Code

this.buttonType = buttonType;

void
setButtonTypeByString

Sets Type Property by String

Name	Type	Help
buttonType	String	Type

Source Code

this.buttonType = buttonType;

void
setIcon

Sets Icon Property

Name	Type	Help
icon	String	Icon

Source Code

this.icon = icon;

void
setItemIcon

Sets the Icon for Item Key

Name	Type	Help
key	String
icon	String

Source Code

if (this.items === undefined || this.items === "" || this.items === "<delete>"){
      return;
    }

    var elementsJson = JSON.parse(this.items);

    // loop and find and update
    for (var i = 0; i < elementsJson.length ; i++){
      if (elementsJson[i].key == key) {
        elementsJson[i].icon = icon;
        break;
      }
    }

    this.items = JSON.stringify(elementsJson);

void
setItemIcons

Sets the Icon for Item keys

Name	Type	Help
keys	String
separator	String
icon	String	Icon

Source Code

if (this.items === undefined || this.items === "" || this.items === "<delete>"){
      return;
    }

    var changeKeys = keys.split(separator);

    var elementsJson = JSON.parse(this.items);

    // loop and find and change
    for (var i = 0; i < elementsJson.length ; i++){
      for (var j = 0; j < changeKeys.length ; j++){
        if (elementsJson[i].key == changeKeys[j]) {
          elementsJson[i].icon = icon;
          break;
        }
      }
    }

    this.items = JSON.stringify(elementsJson);

void
setItemText

Sets the Text for Item Key

Name	Type	Help
key	String
text	String

Source Code

if (this.items === undefined || this.items === "" || this.items === "<delete>"){
      return;
    }

    var elementsJson = JSON.parse(this.items);

    // loop and find and update
    for (var i = 0; i < elementsJson.length ; i++){
      if (elementsJson[i].key == key) {
        elementsJson[i].text = text;
        break;
      }
    }

    this.items = JSON.stringify(elementsJson);

void
setItemTexts

Sets the Text for Item keys

Name	Type	Help
keys	String
separator	String
text	String	Text

Source Code

if (this.items === undefined || this.items === "" || this.items === "<delete>"){
      return;
    }

    var changeKeys = keys.split(separator);

    var elementsJson = JSON.parse(this.items);

    // loop and find and change
    for (var i = 0; i < elementsJson.length ; i++){
      for (var j = 0; j < changeKeys.length ; j++){
        if (elementsJson[i].key == changeKeys[j]) {
          elementsJson[i].text = text;
          break;
        }
      }
    }

    this.items = JSON.stringify(elementsJson);

void
setPlacement

Sets Placement Property by Choice Option

Name	Type	Help
placement	org_scn_community_shared_PlacementEnumfield	Placement

Source Code

this.placement = placement;

void
setPlacementByString

Sets Placement Property by String

Name	Type	Help
placement	String	Placement

Source Code

this.placement = placement;

void
setText

Sets Title Property

Name	Type	Help
text	String	Title

Source Code

this.text = text;

void
updateItem

Updates given Item

Name	Type	Help
key	String	Unique Property Key
text	String	Text
icon	String	Icon

Source Code

if (this.items === undefined || this.items === "" || this.items === "<delete>"){
      this.items = "[]";
    }

    var itemDef = {
      leaf:true,
      key:key,
      text:text,
      icon:icon
    };

    var elementsJson = JSON.parse(this.items);

    // loop and find and update
    for (var i = 0; i < elementsJson.length ; i++){
      if (elementsJson[i].key == elementKey) {
        elementsJson[i] = itemDef;
        break;
      }
    }

    this.items = JSON.stringify(elementsJson);

THE END