Folder

extends Shortcut

java.lang.Object
↳	net.pierrox.lightning_launcher.script.api.Item
	↳	net.pierrox.lightning_launcher.script.api.Shortcut
		↳	net.pierrox.lightning_launcher.script.api.Folder

Class Overview

The folder item extends the shortcut (because it have a label and an icon) and add folder specific services such as open/close.

Summary

Public Methods
void	close() Close the folder if it is currently open.
Container	getContainer() Returns the container holding items for this folder.
Image	getWindowBackground() Retrieve the image currently displayed as the folder window background.
boolean	isOpen() Returns the current folder state.
void	launch() Open the folder if it is currently closed, else close it.
void	open() Open the folder if it not already opened.
void	openFrom(int x, int y) Open the folder if it not already opened, using an absolute position for the start point of the animation.
void	setContainerId(int id) Change the container of this folder.
void	setWindowBackground(Image image) Set a window background image.

[Expand]

Inherited Methods

From class net.pierrox.lightning_launcher.script.api.Shortcut

Image	getCustomIcon() Retrieve the custom icon file associated with this shortcut.
Image	getDefaultIcon() Retrieve the default icon file associated to this shortcut.
Image	getIconLayer(String which) Retrieve the image currently used in a shortcut icon layer.
Image	getImage() Retrieves the live image for this shortcut as displayed on a given screen This is the image which results in compositing the default or custom icon with various options, such as reflection.
Intent	getIntent() Return the intent associated with this shortcut
String	getLabel() Returns the label of this shortcut.
void	launch() Launch the intent associated with this shortcut.
void	setCustomIcon(Image image) Set a new custom icon for this item.
void	setDefaultIcon(Image image) Set a new icon for this item.
void	setIconLayer(Image image, String which, boolean persistent) Set an icon layer image (background, overlay, mask), persistently.
void	setIconLayer(Image image, String which) Set an icon layer image (background, overlay, mask).
void	setImage(Image image) Replaces the current live image on a given screen.
void	setIntent(Intent intent) Set the intent launched by this shortcut.
void	setLabel(String label, boolean persistent) Set the label of this shortcut, possibly making the change persistent.
void	setLabel(String label) Set the label of this shortcut.
String	toString()

From class net.pierrox.lightning_launcher.script.api.Item

Scriptable	extend() Return a new script object, with this item as prototype
Array	getAllBindings() This method is deprecated. use #getBindings instead
Binding	getBindingByTarget(String target) Retrieve a binding by its key, the taget.
Binding[]	getBindings()
Image	getBoxBackground(String state) Retrieve the image currently displayed as the box background.
RectL	getCell() Returns the cell allocated to this item (only works when attached to the grid).
int	getHeight() Returns this item view height.
int	getId() Returns the unique item identifier.
Scriptable	getMy() Return a scriptable object that can be used to store live data.
String	getName()
Container	getParent() Returns the container containing this item.
float	getPositionX()
float	getPositionY()
PropertySet	getProperties() Retrieve properties for this item.
View	getRootView() Retrieve the root android View for this item.
float	getRotation() Returns the rotation angle in degrees.
float	getScaleX() Returns the X scale for this item (only when detached from the grid).
float	getScaleY() Returns the Y scale for this item (only when detached from the grid).
Screen	getScreen()
float	getSkewX() Returns the X skew for this item (only when detached from the grid).
float	getSkewY() Returns the Y skew for this item (only when detached from the grid).
String	getTag() Returns the value associated with this item.
String	getTag(String id) Returns the value associated with this item and id.
String	getType() Returns the item type has a text
int	getWidth() Returns this item view width.
boolean	isVisible() Returns true if the item is visible.
void	setBinding(Binding binding) Set a binding (same as #setBinding(String, String, boolean).
void	setBinding(String target, String formula, boolean enabled) Add or update a binding for this item.
void	setBoxBackground(Image image, String state, boolean persistent) Set a background image, optionally saving the change to file.
void	setBoxBackground(Image image, String state) Set a background image, in memory only, changes will not be persisted and will be lost when the app is restarted.box
void	setCell(int left, int top, int right, int bottom) Set the cell allocated to the item on the grid (only works when attached to the grid).
void	setCell(int left, int top, int right, int bottom, boolean portrait) Set the cell allocated to the item on the grid (only works when attached to the grid), persistently
void	setName(String name)
void	setPosition(float x, float y) Set the position of the item (only when detached from the grid).
void	setRotation(float angle) Set the rotation of the item around its center (only when detached from the grid).
void	setScale(float scaleX, float scaleY) Set the scale of the item (only when detached from the grid).
void	setSize(float width, float height) Set the size of the item (only when detached from the grid).
void	setSkew(float skewX, float skewY) Set the skew of the item (only when detached from the grid).
void	setTag(String id, String value) Set a persistent data for this item.
void	setTag(String value) Set a persistent data for this item.
void	setVisibility(boolean visible) Hide or show an item.
String	toString()
void	unsetBinding(String target) Removes a binding for this item.

From class java.lang.Object

Public Methods

public void close ()

Close the folder if it is currently open. Does nothing if the script is run in the background.

public Container getContainer ()

Returns the container holding items for this folder.

public Image getWindowBackground ()

Retrieve the image currently displayed as the folder window background. Note: the object returned by this method may not be the one set through #setWindowBackground.

Returns

an image, or null if there is no image

public boolean isOpen ()

Returns the current folder state. This function will always return false if the script is run in the background.

Returns

true if the folder is open

public void launch ()

Open the folder if it is currently closed, else close it.

public void open ()

Open the folder if it not already opened. Does nothing when the script is run in background.

public void openFrom (int x, int y)

Open the folder if it not already opened, using an absolute position for the start point of the animation. Does nothing when the script is run in background.

Parameters

x	absolute abscissa on the screen
y	absolute ordinate on the screen

public void setContainerId (int id)

Change the container of this folder. That is: use an alternate set of items in the folder window.

public void setWindowBackground (Image image)

Set a window background image. This is done in memory for a given screen and is not persisted. Note: instances of ImageAnimation are currently not supported

Classes

Folder

Class Overview

Summary

Public Methods

public void close ()

public Container getContainer ()

public Image getWindowBackground ()

Returns

public boolean isOpen ()

Returns

public void launch ()

public void open ()

public void openFrom (int x, int y)

Parameters

public void setContainerId (int id)

public void setWindowBackground (Image image)