public class ClientImageData extends Object
Modifier and Type | Field and Description |
---|---|
String |
alt
The "ALT" property string for IMG.
|
int |
height
Height of image part to display.
|
int |
imageHeight
Height of entire image (when different device pixel ratio or multiple).
|
int |
imageType
Type of client image: 0=bitmap, 1=fontIcon, 2=svg.
|
int |
imageWidth
Width of entire image (when different device pixel ratio or multiple).
|
boolean |
isMulti
Flag indicating multiple image type.
|
int |
width
Width of image part to display.
|
Constructor and Description |
---|
ClientImageData(FontIconDefinition fontIcon)
Creates a new instance for font icons.
|
ClientImageData(String resource,
String alt,
int width,
int height)
Creates a new instance for single-images.
|
ClientImageData(String resource,
String alt,
int width,
int height,
int imageWidth,
int imageHeight,
int offsetX,
int offsetY)
Creates a new instance for multiple-images.
|
ClientImageData(SVGInfo svgInfo)
Creates a new instance for SVG.
|
Modifier and Type | Method and Description |
---|---|
void |
addMulti(String resource,
int matchMask,
int offsetX,
int offsetY)
Adds a multiple image.
|
void |
addSingle(String resource,
int matchMask)
Adds a single image.
|
ClientImageData |
adjustTo(double dpr)
Find best match, i.e.
|
void |
append(PropMgr propertyManager,
Transaction trans,
double dpr)
Appends the image data to a transaction for the specified device pixel ratio.
|
static void |
appendNoData(Transaction trans)
Method to call when no ClientImageData is present and needs to be sent to client.
|
void |
commit()
Commits this definition for no further changes to be used in transactions.
|
ClientImageData |
createMultiResolution(double dpr,
String resource,
int imageWidth,
int imageHeight,
int offsetX,
int offsetY)
Creates a new resolution for a multiple image.
|
ClientImageData |
createSingleResolution(double dpr,
String resource,
int imageWidth,
int imageHeight)
Creates a new resolution for a single image.
|
String |
getDefaultResource()
Gets the default image resource string.
|
String |
getKStringNonBitmap(KStringHTMLImageTag source,
IKStringInfoProvider provider)
Appends the font icon or SVG definition to a KString tag.
|
boolean |
isBitmap()
Returns if the image is a bitmap image type.
|
boolean |
isFontIcon()
Returns if the image is a font icon image type.
|
boolean |
isSVG()
Returns if the image is SVG.
|
String |
toString()
To debug String.
|
public final int imageType
public final boolean isMulti
public final String alt
public final int width
public final int height
public final int imageWidth
public final int imageHeight
public ClientImageData(FontIconDefinition fontIcon)
public ClientImageData(SVGInfo svgInfo)
public ClientImageData(String resource, String alt, int width, int height)
public void addSingle(String resource, int matchMask)
public void addMulti(String resource, int matchMask, int offsetX, int offsetY)
public ClientImageData createSingleResolution(double dpr, String resource, int imageWidth, int imageHeight)
public ClientImageData createMultiResolution(double dpr, String resource, int imageWidth, int imageHeight, int offsetX, int offsetY)
public void commit()
public void append(PropMgr propertyManager, Transaction trans, double dpr)
public static void appendNoData(Transaction trans)
public String getDefaultResource()
public ClientImageData adjustTo(double dpr)
dpr
- The device pixel ratio.public boolean isBitmap()
public boolean isFontIcon()
public boolean isSVG()
public String getKStringNonBitmap(KStringHTMLImageTag source, IKStringInfoProvider provider)
source
- The source KString tag.provider
- The information provider.iizi® is a registered trademark of Mindus SARL. © Copyright 2019 Mindus SARL. All rights reserved.