-
public abstract class EmojiPackA data structure representing an emoji pack. There are many types of packs, based on their origin or the way they need to be handled.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public classEmojiPack.Companion
-
Field Summary
Fields Modifier and Type Field Description private Stringidprivate Stringnameprivate Stringdescriptionprivate Uriwebsiteprivate Urilicenseprivate StringdescriptionLongprivate BooleantintableIcon
-
Method Summary
Modifier and Type Method Description final StringgetId()final UnitsetId(String id)final StringgetName()final UnitsetName(String name)final StringgetDescription()final UnitsetDescription(String description)final UrigetWebsite()final UnitsetWebsite(Uri website)final UrigetLicense()final UnitsetLicense(Uri license)final StringgetDescriptionLong()final UnitsetDescriptionLong(String descriptionLong)final BooleangetTintableIcon()final UnitsetTintableIcon(Boolean tintableIcon)final Unitselect(Context context, EmojiPack previousSelection, Function1<String, Boolean> selectionAllowed, EmojiPreferenceInterface preference)Selects an emoji pack (i.e. abstract DrawablegetIcon(Context context)Returns the icon for this emoji pack. final VersiongetVersion()Returns the current version of this pack. final UnitaddSelectionListener(EmojiPackSelectionListener selectionListener)final UnitremoveSelectionListener(EmojiPackSelectionListener selectionListener)StringtoString()-
-
Constructor Detail
-
EmojiPack
EmojiPack(String id, String name, String description, VersionProvider version, Uri website, Uri license, String descriptionLong, Boolean tintableIcon)
- Parameters:
id- A unique name for the pack.name- The user-facing name of the pack.description- The (short) user-facing description that is visible in the normal emoji pickerversion- The current version of the pack.website- The URL of the website/repository for the emoji packlicense- The URL of the license for the emoji pack (This might be auto-downloaded in the future, so it should point to a rather small/plaintext file, if possible)descriptionLong- A longer description that is shown when the user expands the item for the emoji pack.tintableIcon- Whether the icon should get a tint (if specified by the theme)
-
-
Method Detail
-
getDescription
final String getDescription()
-
setDescription
final Unit setDescription(String description)
- Parameters:
description- The (short) user-facing description that is visible in the normal emoji picker
-
getWebsite
final Uri getWebsite()
-
setWebsite
final Unit setWebsite(Uri website)
- Parameters:
website- The URL of the website/repository for the emoji pack
-
getLicense
final Uri getLicense()
-
setLicense
final Unit setLicense(Uri license)
- Parameters:
license- The URL of the license for the emoji pack (This might be auto-downloaded in the future, so it should point to a rather small/plaintext file, if possible)
-
getDescriptionLong
final String getDescriptionLong()
-
setDescriptionLong
final Unit setDescriptionLong(String descriptionLong)
- Parameters:
descriptionLong- A longer description that is shown when the user expands the item for the emoji pack.
-
getTintableIcon
final Boolean getTintableIcon()
-
setTintableIcon
final Unit setTintableIcon(Boolean tintableIcon)
- Parameters:
tintableIcon- Whether the icon should get a tint (if specified by the theme)
-
select
final Unit select(Context context, EmojiPack previousSelection, Function1<String, Boolean> selectionAllowed, EmojiPreferenceInterface preference)
Selects an emoji pack (i.e. stores the preference and resets EmojiCompat) and deselects the currently selected emoji pack
-
getIcon
abstract Drawable getIcon(Context context)
Returns the icon for this emoji pack. Note: This is done as a function, because at the time the pack object is created, the Context.getTheme might not be initialized yet, so a pre-set icon might be wrongly themed. However, if the icon is theme-independent, it may be stored permanently
-
getVersion
final Version getVersion()
Returns the current version of this pack. Should be called as late as possible.
-
addSelectionListener
final Unit addSelectionListener(EmojiPackSelectionListener selectionListener)
-
removeSelectionListener
final Unit removeSelectionListener(EmojiPackSelectionListener selectionListener)
-
-
-
-