Package com.inet.report

Interface PictureProperties

    • Field Detail

      • ALIGN_VERTICAL_TOP

        static final int ALIGN_VERTICAL_TOP
        The vertical alignment will be top aligned.
        Since:
        7.0
        See Also:
        Constant Field Values

      • ALIGN_VERTICAL_CENTER

        static final int ALIGN_VERTICAL_CENTER
        The vertical alignment will be centered.
        Since:
        7.0
        See Also:
        Constant Field Values

      • ALIGN_VERTICAL_BOTTOM

        static final int ALIGN_VERTICAL_BOTTOM
        The vertical alignment will be bottom aligned.
        Since:
        7.0
        See Also:
        Constant Field Values

      • SCALE_FIT_WIDTH_FIT_HEIGHT

        static final int SCALE_FIT_WIDTH_FIT_HEIGHT
        Stretches the source image to the element frame
        See Also:
        Constant Field Values

      • SCALE_FIXED_WIDTH_FIXED_HEIGHT

        static final int SCALE_FIXED_WIDTH_FIXED_HEIGHT
        Scales the source image by the given scaling factor
        See Also:
        Constant Field Values

      • SCALE_FIT_WIDTH_FIXED_HEIGHT

        static final int SCALE_FIT_WIDTH_FIXED_HEIGHT
        Scales the width of the source image to its element size and the height using the given scale factor.
        See Also:
        Constant Field Values

      • SCALE_FIXED_WIDTH_FIT_HEIGHT

        static final int SCALE_FIXED_WIDTH_FIT_HEIGHT
        Scales the width of the source image by the given scaling factor and scales its height to the height of the element.
        See Also:
        Constant Field Values

      • SCALE_FIT_WIDTH_KEEP_ASPECT_RATIO

        static final int SCALE_FIT_WIDTH_KEEP_ASPECT_RATIO
        Scales the width of the source image to its element size while keeping the correct aspect ratio.
        See Also:
        Constant Field Values

      • SCALE_FIT_HEIGHT_KEEP_ASPECT_RATIO

        static final int SCALE_FIT_HEIGHT_KEEP_ASPECT_RATIO
        Scales the height of the source image to its element size while keeping the correct aspect ratio.
        See Also:
        Constant Field Values

      • SCALE_BEST_FIT_KEEP_ASPECT_RATIO

        static final int SCALE_BEST_FIT_KEEP_ASPECT_RATIO
        Scales the source image to fit in the bounds of its element size while keeping the correct aspect ratio.
        See Also:
        Constant Field Values

    • Method Detail

      • setBottomCropping

        void setBottomCropping​(int bottomCropping)
        Sets the value of the property 'bottom cropping size'.
        Parameters:
        bottomCropping - The long value of the property 'bottom cropping size'.
        Since:
        6.0

      • getBottomCropping

        int getBottomCropping()
        Gets the value of the property 'bottom cropping size'.
        Returns:
        The long value of the property 'bottom cropping size'.
        Since:
        6.0

      • setLeftCropping

        void setLeftCropping​(int leftCropping)
        Sets the value of the property 'left cropping size'.
        Parameters:
        leftCropping - The value of the property 'left cropping size'.
        Since:
        6.0

      • getLeftCropping

        int getLeftCropping()
        Gets the value of the property 'left cropping size'.
        Returns:
        The value of the property 'left cropping size'.
        Since:
        6.0

      • setRightCropping

        void setRightCropping​(int rightCropping)
        Sets the value of the property 'right cropping size'.
        Parameters:
        rightCropping - The long value of the property 'right cropping size'.
        Since:
        6.0

      • getRightCropping

        int getRightCropping()
        Gets the value of the property 'right cropping size'.
        Returns:
        The value of the property 'right cropping size'.
        Since:
        6.0

      • setTopCropping

        void setTopCropping​(int topCropping)
        Sets the value of the property 'top cropping size'.
        Parameters:
        topCropping - The value of the property 'top cropping size'.
        Since:
        6.0

      • getTopCropping

        int getTopCropping()
        Gets the value of the property 'top cropping size'.
        Returns:
        The long value of the property 'top cropping size'.
        Since:
        6.0

      • getWidthScalingFactor

        double getWidthScalingFactor()
        Gets the property 'width scaling factor'.
        Returns:
        The value of the property 'width scaling factor'. I.e. 0.1 means 10%, 1.0 5.0 means 500%.
        Since:
        6.0

      • setWidthScalingFactor

        void setWidthScalingFactor​(double factor)
        Sets the property 'width scaling factor'.
        Parameters:
        factor - The value of the property 'width scaling factor'. I.e. 0.1 means 10%, 5.0 means 500%.
        Since:
        6.0

      • setHeightScalingFactor

        void setHeightScalingFactor​(double factor)
        Sets the property 'height scaling factor'.
        Parameters:
        factor - The value of the property 'height scaling factor'. I.e. 0.1 means 10%, 5.0 means 500%.
        Since:
        6.0

      • getHeightScalingFactor

        double getHeightScalingFactor()
        Gets the property 'height scaling factor'.
        Returns:
        The value of the property 'height scaling factor'. I.e. 0.1 means 10%, 5.0 means 500%.
        Since:
        6.0

      • getWidthRenderingFactor

        double getWidthRenderingFactor()
        Gets the property 'width rendering factor'. While 'width scaling factor' is a user defined faction this rendering factor includes the user factor and the image resolution if available. Otherwise it is equal to width scaling factor
        Returns:
        The value of the property 'width scaling factor'. I.e. 0.1 means 10%, 5.0 means 500%.
        Since:
        8.2

      • getHeightRenderingFactor

        double getHeightRenderingFactor()
        Gets the property 'height rendering factor'. While 'height scaling factor' is a user defined factor, this rendering factor includes the user factor and the image resolution if available. Otherwise it is equal to height scaling factor.
        Returns:
        The value of the property 'height scaling factor'. I.e. 0.1 means 10%, 5.0 means 500%.
        Since:
        8.2

      • setVerAlign

        void setVerAlign​(int value)
        Sets the value of the property 'vertical alignment'. Possible alignments are default, left, center, right or justified.
        Parameters:
        value - The new value of the property 'vertical alignment'.
        Since:
        6.0
        See Also:
        ALIGN_VERTICAL_TOP, ALIGN_VERTICAL_CENTER, ALIGN_VERTICAL_BOTTOM

      • getVerAlign

        int getVerAlign()
        Returns the value of the property 'vertical alignment'. Possible alignments are default, left, center, right or justified.
        Returns:
        the 'vertical alignment' property of this element.
        Since:
        6.0
        See Also:
        ALIGN_VERTICAL_TOP, ALIGN_VERTICAL_CENTER, ALIGN_VERTICAL_BOTTOM

      • isCanShrink

        boolean isCanShrink()
        Returns the value of the property 'can shrink'. If this property is enabled an element with dynamic state will be shrunk when the content of the element is smaller than its container.
        Returns:
        The value of the property 'can shrink'.
        Since:
        7.0

      • setCanShrink

        void setCanShrink​(boolean canShrink)
        Sets the value of the property 'can shrink'. If this property is enabled an element with dynamic state will be shrunk when the content of the element is smaller than its container.
        Parameters:
        canShrink - If true shrinking to the image size is allowed.
        Since:
        6.0

      • getCanShrinkFormula

        FormulaField getCanShrinkFormula()
        Returns the formula of the property 'can shrink'. If this property is enabled an element with dynamic state will be shrunk dynamically when the content of the element is larger than its container.
        Returns:
        FormulaField The formula of the property 'can grow'.
        Since:
        6.0

      • setCanShrinkFormula

        void setCanShrinkFormula​(FormulaField newFormula)
        Sets the formula for the property 'can shrink'. If this property is enabled an element with dynamic state will be shrunk dynamically when then content of the element is larger than its container.
        Parameters:
        newFormula - The new formula for the property 'can grow'.
        Since:
        6.0

      • setWidth

        void setWidth​(int width)
        Sets the width of an element. The unit is in twips.
        Parameters:
        width - The width in twips.
        Since:
        7.0

      • getWidth

        int getWidth()
        Gets the width of an element. Use the 'element width' property to change the width of the element. The unit is in twips.
        Returns:
        The width in twips.
        Throws:
        java.lang.UnsupportedOperationException - if this element spans multiple sections
        Since:
        7.0

      • setHeight

        void setHeight​(int height)
        Sets the height of an element. Use the 'element height' property to change the height of the element. The unit is in twips.
        Parameters:
        height - The height in twips.
        Throws:
        java.lang.UnsupportedOperationException - if this element spans multiple sections
        Since:
        7.0

      • getHeight

        int getHeight()
        Gets the height of an element. Use the 'element height' property to change the height of the element. The unit is in twips.
        Returns:
        The height in twips.
        Throws:
        java.lang.UnsupportedOperationException - if this element spans multiple sections
        Since:
        7.0

      • isCanGrow

        boolean isCanGrow()
        Returns the value of the property 'can grow'. If this property is enabled, an element with dynamic state will be expanded vertically if its content is larger than its container. If this property is disabled the content will be truncated when its size is larger than the container.
        Returns:
        The value of the property 'can grow'.
        Since:
        7.0

      • setCanGrow

        void setCanGrow​(boolean canGrow)
        Sets the value of the property 'can grow'. If this property is enabled, an element with dynamic state will be expanded vertically if its content is larger than its container. If this property is disabled the content will be truncated when its size is larger than the container.
        Parameters:
        canGrow - The new value of the property 'can grow'
        Since:
        7.0

      • getCanGrowFormula

        FormulaField getCanGrowFormula()
        Returns the formula of the property 'can grow'. If this property is enabled, an element with dynamic state will be expanded vertically if its content is larger than its container. If this property is disabled the content will be truncated when its size is larger than the container.
        Returns:
        FormulaField The formula of the property 'can grow'.
        Since:
        7.0

      • setCanGrowFormula

        void setCanGrowFormula​(FormulaField newFormula)
        Sets the formula for the property 'can grow'. If this property is enabled, an element with dynamic state will be expanded vertically if its content is larger than its container. If this property is disabled the content will be truncated when its size is larger than the container.
        Parameters:
        newFormula - The new formula for the property 'can grow'.
        Since:
        7.0

      • getHorAlignFormula

        FormulaField getHorAlignFormula()
        Returns the formula for the property 'horizontal alignment'. Possible alignments are default, left, center, right or justified.
        Returns:
        FormulaField The formula for the property 'horizontal alignment'.
        Since:
        7.0

      • setImageKeyFormula

        void setImageKeyFormula​(FormulaField newFormula)
        Sets a Formulafield which contains a key string to identify identical images. Renderers which are using a cache mechanism (e.g. PDF) can use this key to optimize its rendering and memory performance. Picture Objects with the same key will be treated as the picture objects with the same image.
        Parameters:
        newFormula - the formula containing the image key.
        Since:
        9.2

      • getImageKeyFormula

        FormulaField getImageKeyFormula()
        Return the image key formula for this picture. Renderers which are using a cache mechanism (e.g. PDF) can use this key to optimize its rendering and memory performance. Picture Objects with the same key will be treated as the picture objects with the same image.
        Returns:
        Return the image key formula for this picture.
        Since:
        9.2

      • createPictureMetaData

        @Nullable
com.inet.report.encode.PictureMetaData createPictureMetaData()
        Creates a meta data instance for this picture.
        Returns:
        the created meta data instance or null if no meta data can be retrieved (e.g. when picture data is missing or the data format is unknown)
        Since:
        12.1