Class PWAIcons

Method Details

• build

  public static PWAIcons build(PWAIcons.Sources sources) throws IOException

  Builds the icons of an application from its sources, in the order the class description gives: the designer's folder file, the named image, the iiziRun icon set, generation from the master. A file no source can give is left out (an application without a master and without the folder's files has no icons at all).

  Parameters:

  sources - The sources.

  Returns:

  The icons, possibly without a single file.

  Throws:

  IOException - If the master is given but is not a square PNG of at least 512 px, or if a named image cannot be read: the text names the problem, never a byte of the image.

• generate

  public static PWAIcons generate(byte[] master, Color fallback) throws IOException

  Generates every icon from a master icon alone, on a given background when the image has no edge colour: the shape the tests and the Designer's preview use.

  Parameters:

  master - The PNG bytes of the master icon.

  fallback - The background when the image has no edge colour, null for the default.

  Returns:

  The icons.

  Throws:

  IOException - If the master is not a square PNG of at least 512 px.

• checkMaster

  public static String checkMaster(byte[] data)

  Checks the master icon (ruling PX-1): a PNG, square, at least MASTER_MIN_SIZE px.

  Parameters:

  data - The bytes.

  Returns:

  null when the master is accepted, else the problem as a phrase that completes "The master icon ...": "is not a PNG file", "is not square (width=.., height=..)", "is smaller than 512 x 512 (width=..)".

• checkMasterFile

  public static String checkMasterFile(File file)

  Checks a master icon file before anything is created from it (the iiziRun setup dialog's own check, ruling W-D-3): the file is read and its bytes checked as checkMaster(byte[]) does. Nothing is written. (Its own name: an overload would make checkMaster(null) ambiguous.)

  Parameters:

  file - The file.

  Returns:

  null when the master is accepted, else the problem as a phrase that completes "The icon file ...": the phrases of checkMaster(byte[]), or "cannot be read (..)" when the file cannot be read.

• isPNG

  public static boolean isPNG(byte[] data)

  Checks whether bytes start with the PNG signature.

  Parameters:

  data - The bytes.

  Returns:

  true for a PNG file.

• hasTransparency

  public static boolean hasTransparency(byte[] data)

  Checks whether an image has a pixel that is not fully opaque (the platform rule for a maskable or Apple icon: Android fills the mask with the icon, iOS shows transparency as black).

  Parameters:

  data - The PNG bytes.

  Returns:

  true when a pixel is not opaque; false for an opaque image, or for bytes that are not an image.

• getBackground

  public static Color getBackground(ModuleApp app)

  Picks the App's background for the maskable and Apple icons when an image has no edge colour: the App's iconBG, else its themeColor, else null for DEFAULT_BACKGROUND. A colour counts only when it is an opaque literal, or a reference that resolves to one for the light scheme (opaque(ModuleApp,GColor,String)).

  Parameters:

  app - The App, or null.

  Returns:

  The colour, or null for the default.

• opaque

  public static GColor opaque(ModuleApp app, GColor c, String scheme)

  Gets a colour of an App when it is an opaque literal, a referenced colour (%...: a palette colour of the module, or a platform role) resolved first through the App's tree for a scheme, by the one algorithm the server and the Designer use (ColorResolver; CC-FIX-NAMED-COLOR-UNRESOLVED - a reference counted as no colour before, while the Designer's App page showed it resolved).

  Parameters:

  app - The App the colour belongs to: the tree its reference is resolved in.

  c - The colour, or null.

  scheme - The scheme a reference is resolved for, PaletteColor.SCHEME_LIGHT or PaletteColor.SCHEME_DARK.

  Returns:

  The colour, or null when absent, inherited, a reference that does not resolve to a literal, or not opaque.

• iiziRunRequired

  public static List<String> iiziRunRequired(Map<String,byte[]> assets)

  Gets the files of iiziRun's icon set the runtime builder checks and the Cordova configuration names, by path relative to the assets directory, in the builder's order, each once: the squares (RuntimeBuilderSettings.ICONS_COMMON); the Android icons (RuntimeBuilderSettings.ICONS_ANDROID_STANDARD under android/) and IIZIRUN_NODOT; the adaptive foreground layers (f<size>.png of RuntimeBuilderSettings.ICONS_ANDROID_ADAPTIVE_SIZE under IIZIRUN_ADAPTIVE) with bgcolor.xml, or with the background layers b<size>.png when the folder already has one of them and no bgcolor.xml (the builder's other form); the iOS icons (RuntimeBuilderSettings.ICONS_IOS under ios/).

  The adaptive files are left out when the set has Android icons of the designer's and not a single adaptive file: the builder then uses those icons alone, and an adaptive layer added beside them would replace them on every launcher since Android 8.

  Parameters:

  assets - The module's asset files by path relative to the assets directory with '/' separators, those under IIZIRUN_ICONS at least; null for none.

  Returns:

  The paths.

• iiziRunMissing

  public static Map<String,byte[]> iiziRunMissing(byte[] master, Map<String,byte[]> assets, Color fallback) throws IOException

  Generates the files iiziRun's icon set lacks from the master icon: every path of iiziRunRequired(Map) the assets do not hold - a file the set has is never replaced. The squares and the Android icons are the master scaled, transparency kept; the adaptive foreground layers are the content (the master's own alpha, or what differs from its edge colour) trimmed and fitted inside ADAPTIVE_SAFE_ZONE on transparency; the background is the image's edge colour, else the fallback, else DEFAULT_BACKGROUND, written as bgcolor.xml (or as opaque b<size>.png layers); the iOS icons are the master scaled to the whole square and drawn on that background, without an alpha channel; nodot.png is one transparent pixel.

  Parameters:

  master - The PNG bytes of the master icon (square, at least 512).

  assets - The module's asset files by path relative to the assets directory with '/' separators, those under IIZIRUN_ICONS at least; null for none.

  fallback - The App's background when the master has no edge colour (getBackground(ModuleApp)), null for the default.

  Returns:

  The missing files, path relative to the assets directory to bytes, in the order of iiziRunRequired(Map); empty when the set is complete.

  Throws:

  IOException - If the master is not a square PNG of at least 512 px: the text names the problem.

• iiziRunMissingUnder

  public static Map<String,byte[]> iiziRunMissingUnder(File icons, byte[] master, byte[] ios, Color fallback) throws IOException

  Generates the files iiziRun's icon set under a directory lacks, as the iiziRun setup wizard needs them: the set is read from the directory and its sub-folders, the missing files are iiziRunMissing(byte[],Map,Color)'s, and the iOS icons may come from a second, opaque master (the wizard's opaque icon file). A file the directory has is never generated, whatever its bytes.

  Parameters:

  icons - The set's directory (<module>/assets/iiziRun/icons), possibly absent; null for an empty set.

  master - The PNG bytes of the master icon (square, at least 512): the squares, the Android icons and the adaptive layers, and the iOS icons when ios is null.

  ios - The PNG bytes of the master of the iOS icons (square, at least 512), or null for master.

  fallback - The App's background when a master has no edge colour (getBackground(ModuleApp)), null for the default.

  Returns:

  The missing files by path relative to icons with '/' separators (512.png, android/adaptive/f256.png, ios/180.png) to bytes, in the order of iiziRunRequired(Map); empty when the set is complete.

  Throws:

  IOException - If a master is not a square PNG of at least 512 px (the text names the problem), or a file of the set cannot be read.

• getFileNames

  public Set<String> getFileNames()

  Gets the names of the files, in the order of the table in the class description.

  Returns:

  The served names.

• get

  public byte[] get(String fileName)

  Gets a copy of a file.

  Parameters:

  fileName - The served name, e.g. ICON_192.

  Returns:

  The PNG bytes, or null for a name this instance does not hold.

• getOrigin

  public PWAIcons.Origin getOrigin(String fileName)

  Gets where a file came from.

  Parameters:

  fileName - The served name.

  Returns:

  The origin, or null for a name this instance does not hold.

• missing

  public Map<String,byte[]> missing()

  Gets the files the PWA folder lacks: every file not of PWAIcons.Origin.DESIGNER, by its path in the folder relative to the assets directory. The Designer writes them when the PWA page is applied (ruling PD-2), never over a designer's file.

  Returns:

  The missing files, path to PNG bytes (copies), in the order of the table.

• getBackground

  public Color getBackground()

  Gets the background the generated maskable and Apple icons were drawn on.

  Returns:

  The opaque colour.