Interface IImageTarget

All Superinterfaces:
IGProp<GProp<?>[]>, IPropCnr
All Known Implementing Classes:
EditorFontIconDefinition, EditorImageDefinition, EditorImageLocation, EditorStyledImageDefinition, EditorSVGDefinition, FontIconDefinition, ImageDefinition, ImageLocation, RuntimeImageDefinition, StyledImageDefinition, SVGDefinition

public interface IImageTarget extends IPropCnr
Interface implemented by Image properties that can be referenced.
Author:
Christopher Mindus
  • Method Details Link icon

    • getClientImageData Link icon

      ClientImageData getClientImageData()
      Gets the Client image data.
    • isImageTargetValid Link icon

      boolean isImageTargetValid()
      Checks if this target is valid.
    • getWidth Link icon

      default int getWidth()
      Gets the width of the BITMAP image.
      Returns:
      The width in pixels of Display Pixel Ratio (DPR) 1.0, zero for none (always zero for font icons and SVGs), -1 when image is unresolved.
    • getHeight Link icon

      default int getHeight()
      Gets the height of the BITMAP image.
      Returns:
      The height in pixels of Display Pixel Ratio (DPR) 1.0, zero for none (always zero for font icons and SVGs), -1 when image is unresolved.
    • isBitmap Link icon

      default boolean isBitmap()
      Checks if this is a bitmap image.
      Returns:
      true only if this is a resolved bitmap image.
    • isSingleBitmap Link icon

      default boolean isSingleBitmap()
      Checks if this is a single bitmap image.
      Returns:
      true only if this is a resolved single bitmap image.
    • isBitmapPart Link icon

      default boolean isBitmapPart()
      Checks if this is a bitmap image being part of a larger bitmap.
      Returns:
      true only if this is a resolved bitmap image being part of a larger bitmap.
    • isFontIcon Link icon

      default boolean isFontIcon()
      Checks if this is a font icon image.
      Returns:
      true only if this is a resolved font icon.
    • isSVG Link icon

      default boolean isSVG()
      Checks if this is an SVG image.
      Returns:
      true only if this is a resolved SVG image.
    • lookUp Link icon

      static IImageTarget lookUp(GProp<?> property, String reference)
      Static look-up of an image from a reference. A property attached to the property tree of any kind is required (the more "root" the faster).
      Parameters:
      property - The property used as reference look-up.
      reference - The reference to look-up, null for none.
      Returns:
      The image, or null if not found (or none, or "property" is null).