mirror of
https://github.com/TrianguloY/LightningLauncher.git
synced 2025-01-15 03:40:49 +01:00
Added descriptions for some classes and methods. Fixed small typos in some of them.
This commit is contained in:
parent
5242393ff7
commit
bd6b001a57
7 changed files with 38 additions and 15 deletions
|
@ -6,6 +6,9 @@ import net.pierrox.lightning_launcher.script.api.screen.Screen;
|
||||||
import net.pierrox.lightning_launcher.views.item.CustomViewView;
|
import net.pierrox.lightning_launcher.views.item.CustomViewView;
|
||||||
import net.pierrox.lightning_launcher.views.item.ItemView;
|
import net.pierrox.lightning_launcher.views.item.ItemView;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A CustomView is an advance special item that can display any Android View.
|
||||||
|
*/
|
||||||
public class CustomView extends Item {
|
public class CustomView extends Item {
|
||||||
/**
|
/**
|
||||||
* @hide
|
* @hide
|
||||||
|
|
|
@ -62,6 +62,10 @@ public class Item {
|
||||||
return object;
|
return object;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Return the Screen where this item is placed.
|
||||||
|
* @return the screen containing this item
|
||||||
|
*/
|
||||||
public Screen getScreen() {
|
public Screen getScreen() {
|
||||||
return mLightning.createScreen(mItemView.getParentItemLayout().getScreen());
|
return mLightning.createScreen(mItemView.getParentItemLayout().getScreen());
|
||||||
}
|
}
|
||||||
|
|
|
@ -514,7 +514,7 @@ public class LL {
|
||||||
* @return an animation or null in case of error (most likely out of memory)
|
* @return an animation or null in case of error (most likely out of memory)
|
||||||
*
|
*
|
||||||
* @deprecated use {@link Image#createAnimation(int, int, int, int, int)} instead
|
* @deprecated use {@link Image#createAnimation(int, int, int, int, int)} instead
|
||||||
* <br><code>LL.createAnimation(width, height, count, duration, loopCount) -> Image.createImage(width, height, count, duration, loopCount)</code>
|
* <br><code>LL.createAnimation(width, height, count, duration, loopCount) -> Image.createAnimation(width, height, count, duration, loopCount)</code>
|
||||||
*/
|
*/
|
||||||
public ImageAnimation createAnimation(int width, int height, int count, int duration, int loopCount) {
|
public ImageAnimation createAnimation(int width, int height, int count, int duration, int loopCount) {
|
||||||
return Image.createAnimation(width, height, count, duration, loopCount);
|
return Image.createAnimation(width, height, count, duration, loopCount);
|
||||||
|
|
|
@ -2,6 +2,9 @@ package net.pierrox.lightning_launcher.script.api;
|
||||||
|
|
||||||
import net.pierrox.lightning_launcher.views.item.ItemView;
|
import net.pierrox.lightning_launcher.views.item.ItemView;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Represents a Page Indicator Item. No extra methods available.
|
||||||
|
*/
|
||||||
public class PageIndicator extends Item {
|
public class PageIndicator extends Item {
|
||||||
/**
|
/**
|
||||||
* @hide
|
* @hide
|
||||||
|
|
|
@ -7,6 +7,9 @@ import net.pierrox.lightning_launcher.R;
|
||||||
|
|
||||||
import java.util.LinkedHashMap;
|
import java.util.LinkedHashMap;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Enumeration class. Represents a Property object {@see PropertySet} {@see PropertyEditor}.
|
||||||
|
*/
|
||||||
public class Property {
|
public class Property {
|
||||||
public static final int TYPE_UNKNOWN = -1;
|
public static final int TYPE_UNKNOWN = -1;
|
||||||
public static final int TYPE_BOOLEAN = 0;
|
public static final int TYPE_BOOLEAN = 0;
|
||||||
|
|
|
@ -14,8 +14,8 @@ import android.util.Pair;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Access to container and item properties (aka settings).
|
* Access to container and item properties (aka settings).
|
||||||
* This object provides a way to query for configuration options as well as a mean to update them (see {@link #edit()}.
|
* This object provides a way to query for configuration options as well as a mean to update them (see {@link #edit()}).
|
||||||
* Properties are accessed through their named. There are different property classes:
|
* Properties are accessed through their name. There are different property classes:
|
||||||
* <ul>
|
* <ul>
|
||||||
* <li>container properties: options that can be seen in the desktop, folder and panel settings screen</li>
|
* <li>container properties: options that can be seen in the desktop, folder and panel settings screen</li>
|
||||||
* <li>item properties: options available to all objects (such as box properties or pin mode)</li>
|
* <li>item properties: options available to all objects (such as box properties or pin mode)</li>
|
||||||
|
|
|
@ -2,7 +2,9 @@ package net.pierrox.lightning_launcher.script.api;
|
||||||
|
|
||||||
import android.graphics.Rect;
|
import android.graphics.Rect;
|
||||||
|
|
||||||
/** A rectangle class. */
|
/**
|
||||||
|
* A rectangle class in the format left-top-rigth-bottom.
|
||||||
|
*/
|
||||||
public class RectL {
|
public class RectL {
|
||||||
private int l, t, r, b;
|
private int l, t, r, b;
|
||||||
|
|
||||||
|
@ -13,6 +15,10 @@ public class RectL {
|
||||||
this.b = b;
|
this.b = b;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Copy constructor. Creates a copy of the RectL
|
||||||
|
* @param r the rectL which will be copied.
|
||||||
|
*/
|
||||||
public RectL(android.graphics.Rect r) {
|
public RectL(android.graphics.Rect r) {
|
||||||
this(r.left, r.top, r.right, r.bottom);
|
this(r.left, r.top, r.right, r.bottom);
|
||||||
}
|
}
|
||||||
|
@ -29,6 +35,10 @@ public class RectL {
|
||||||
return "["+l+","+t+","+r+","+b+"]";
|
return "["+l+","+t+","+r+","+b+"]";
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns a java Rect with the same values.
|
||||||
|
* @return Java Rect object with the same values.
|
||||||
|
*/
|
||||||
public Rect toRect() {
|
public Rect toRect() {
|
||||||
return new Rect(l, t, r, b);
|
return new Rect(l, t, r, b);
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in a new issue