Container

Create a new custom view using default values.

Create a new empty folder with the default icon and size.

Create a new page indicator using default values.

Create a new empty panel. All coordinates are in pixels and rounded to the nearest cell when the item is attached to the grid.

Create a new shortcut with the default icon and size.

Create a new stop point with the default configuration.

Requests a manual application of the selected icon pack. The icon pack can either be configured from the settings screen or the "iconPack" container property. Setting the property "iconPack" will not automatically update icons for the container and this method need to be called afterwards. Manually applying the icon pack can also be useful if shortcuts intents have been changed or if the icon pack has been updated. Important note: no container modification should occur during this operation. This will always be true when the method is called with the synchronous parameter set to true, but the app will be frozen. When this parameter is set to false, the method will still return only when the operation is complete, but the user will be able to interact with the app in the meantime. Displaying a progress dialog will help in avoiding modifications but background operations/script executions can still take place.

Stop inertial movement initiated by a fling. Does nothing when the script is run in background.

Clone an item, including containers if any, recursively. Widgets are not fully cloned and need an user action to be fully restored. The position of the newly created item is automatically chosen.

Return a new script object, with this container as prototype

Returns the list of items in this container

Returns the area covered by items in this container. This function will return an empty rect if the container has not been displayed yet or if the script is run in background.

Returns the current computed cell width. It will return 0 if the script is run in background.

Returns the current computed cell width. It will return 0 if the script is run in background.

Returns the height of this container. This function will return 0 if the script is run in background.

Returns the container unique identifier.

Retrieve an item using its identifier.

Retrieve an item using its name. If two or more items have the same name, the first is returned.

Returns the Z-index of the item in the container.

Returns the list of items in this container

Return a scriptable object that can be used to store live data. These data won't be stored, unlike tags.

Returns the item used to open this container. This can either be a Folder or a Panel.

Returns the parent container for this container, or null if this container is a desktop.

Returns the current scale. This function will return 1 if the script is run in background.

Returns the current absolute horizontal position. This function will return 0 if the script is run in background.

Returns the current absolute vertical position. This function will return 0 if the script is run in background.

Retrieve container properties (configuration data). Please note that modifying properties for a container is particularly expensive and slow.

Returns the value associated with this container. Same as getTag(null)

Returns the value associated with this container. Can be undefined if it has never been set. Using a null id is the same as using getTag() without argument.

Used to identify the kind of this container.

Retrieve the android View for this container. This function will return null if the script is run in background.

Returns the width of this container. This function will return 0 if the script is run in background.

Move an item from this container to another container. Warning: moving an item will change its identifier. Any reference to this item should be cleared, for instance this way: var item = container_a.getItemByName('some_item'); item = container_a.moveItem(item, container_b); Additionally both containers may be reloaded and references to other items in these container may become invalid too.

This method removes custom icons and layer images. It also reset the inner icon scale to 1. The purpose is to "cancel" the application of an icon pack.

Remove an item, without confirmation, whatever its type.

Manually set a bounding box for this container. The bounding box is interpreted according to the "Fit desktop to items" option.

Move an item to another layer. This method will do nothing if the item cannot be found in this container.

Go to a specified absolute position in this container. Does nothing when the script is run in background.

Go to a specified absolute position in this container, setting a scale of 1 and using animations.

Set a custom and persistent data for this container. Using a null id is the same as using setTag(String) without the id argument.

Set a custom and persistent data for this container. Same as setTag(null, value)

Display the Lightning "Add item" dialog. This method will do nothing if the script is run in background. The position of the item is automatically selected. During the item selection process, the app can be stopped by the system. As a consequence the newly created item (if any) is not retrieved through this method, use the container "Item added" event instead.

Convert horizontal coordinates in this container into screen coordinates. This function will return y if the script is run in background.

Convert vertical coordinates in this container into screen coordinates. This function will return y if the script is run in background.

Update the items bounding box. This should be called after items have been moved or resized. Since it can be an expansive operation, it is best to call this method once for many item, not after every item geometry change (if possible).