Package org.compiere.print.layout

Class HTMLRenderer

    • Constructor Detail

      • HTMLRenderer

        public HTMLRenderer()

      • HTMLRenderer

        public HTMLRenderer​(ViewFactory f,
                    View v)
        Constructor
        Parameters:
        f - factory
        v - root view

    • Method Detail

      • get

        public static HTMLRenderer get​(String html)
        Get View from HTML String
        Parameters:
        html - html string
        Returns:
        renderer view

      • getWidth

        public float getWidth()
        Get Width
        Returns:
        width

      • getHeight

        public float getHeight()
        Get Height
        Returns:
        height

      • getHeightOneLine

        public float getHeightOneLine()
        Get Height for one line
        Returns:
        height

      • setAllocation

        public void setAllocation​(int width,
                          int height)
        Set Allocation (actual print size)
        Parameters:
        width - actual print width
        height - actual print height

      • setAllocation

        public void setAllocation​(Rectangle allocation)
        Set Allocation (actual size)
        Parameters:
        allocation - actual print size

      • getAllocation

        public Rectangle getAllocation()
        Get Allocation
        Returns:
        actual print size or if not defined the renderer size

      • getAttributes

        public AttributeSet getAttributes()
        Fetches the attributes to use when rendering. At the root level there are no attributes. If an attribute is resolved up the view hierarchy this is the end of the line.
        Overrides:
        getAttributes in class View
        Returns:
        attribute set

      • getPreferredSpan

        public float getPreferredSpan​(int axis)
        Determines the preferred span for this view along an axis.
        Specified by:
        getPreferredSpan in class View
        Parameters:
        axis - may be either X_AXIS or Y_AXIS
        Returns:
        the span the view would like to be rendered into. Typically the view is told to render into the span that is returned, although there is no guarantee. The parent may choose to resize or break the view.

      • getMinimumSpan

        public float getMinimumSpan​(int axis)
        Determines the minimum span for this view along an axis.
        Overrides:
        getMinimumSpan in class View
        Parameters:
        axis - may be either X_AXIS or Y_AXIS
        Returns:
        the span the view would like to be rendered into. Typically the view is told to render into the span that is returned, although there is no guarantee. The parent may choose to resize or break the view.

      • getMaximumSpan

        public float getMaximumSpan​(int axis)
        Determines the maximum span for this view along an axis.
        Overrides:
        getMaximumSpan in class View
        Parameters:
        axis - may be either X_AXIS or Y_AXIS
        Returns:
        the span the view would like to be rendered into. Typically the view is told to render into the span that is returned, although there is no guarantee. The parent may choose to resize or break the view.

      • getAlignment

        public float getAlignment​(int axis)
        Determines the desired alignment for this view along an axis.
        Overrides:
        getAlignment in class View
        Parameters:
        axis - may be either X_AXIS or Y_AXIS
        Returns:
        the desired alignment, where 0.0 indicates the origin and 1.0 the full span away from the origin

      • paint

        public void paint​(Graphics g,
                  Shape allocation)
        Renders the view.
        Specified by:
        paint in class View
        Parameters:
        g - the graphics context
        allocation - the region to render into

      • setParent

        public void setParent​(View parent)
        Sets the view parent.
        Overrides:
        setParent in class View
        Parameters:
        parent - the parent view

      • getViewCount

        public int getViewCount()
        Returns the number of views in this view. Since this view simply wraps the root of the view hierarchy it has exactly one child.
        Overrides:
        getViewCount in class View
        Returns:
        the number of views
        See Also:
        getView(int)

      • getView

        public View getView​(int n)
        Gets the n-th view in this container.
        Overrides:
        getView in class View
        Parameters:
        n - the number of the view to get
        Returns:
        the view

      • modelToView

        public Shape modelToView​(int pos,
                         Shape a,
                         Position.Bias b)
                  throws BadLocationException
        Provides a mapping from the document model coordinate space to the coordinate space of the view mapped to it.
        Specified by:
        modelToView in class View
        Parameters:
        pos - the position to convert
        a - the allocated region to render into
        b - position
        Returns:
        the bounding box of the given position
        Throws:
        BadLocationException

      • modelToView

        public Shape modelToView​(int p0,
                         Position.Bias b0,
                         int p1,
                         Position.Bias b1,
                         Shape a)
                  throws BadLocationException
        Provides a mapping from the document model coordinate space to the coordinate space of the view mapped to it.
        Overrides:
        modelToView in class View
        Parameters:
        p0 - the position to convert >= 0
        b0 - the bias toward the previous character or the next character represented by p0, in case the position is a boundary of two views.
        p1 - the position to convert >= 0
        b1 - the bias toward the previous character or the next character represented by p1, in case the position is a boundary of two views.
        a - the allocated region to render into
        Returns:
        the bounding box of the given position is returned
        Throws:
        BadLocationException - if the given position does not represent a valid location in the associated document
        IllegalArgumentException - for an invalid bias argument
        See Also:
        View.viewToModel(float, float, java.awt.Shape, javax.swing.text.Position.Bias[])

      • viewToModel

        public int viewToModel​(float x,
                       float y,
                       Shape a,
                       Position.Bias[] bias)
        Provides a mapping from the view coordinate space to the logical coordinate space of the model.
        Specified by:
        viewToModel in class View
        Parameters:
        x - x coordinate of the view location to convert
        y - y coordinate of the view location to convert
        a - the allocated region to render into
        bias - bias
        Returns:
        the location within the model that best represents the given point in the view

      • getDocument

        public Document getDocument()
        Returns the document model underlying the view.
        Overrides:
        getDocument in class View
        Returns:
        the model

      • getStartOffset

        public int getStartOffset()
        Returns the starting offset into the model for this view.
        Overrides:
        getStartOffset in class View
        Returns:
        the starting offset

      • getEndOffset

        public int getEndOffset()
        Returns the ending offset into the model for this view.
        Overrides:
        getEndOffset in class View
        Returns:
        the ending offset

      • getElement

        public Element getElement()
        Gets the element that this view is mapped to.
        Overrides:
        getElement in class View
        Returns:
        the view

      • setSize

        public void setSize​(float width,
                    float height)
        Sets the view size.
        Overrides:
        setSize in class View
        Parameters:
        width - the width
        height - the height

      • getViewFactory

        public ViewFactory getViewFactory()
        Fetches the factory to be used for building the various view fragments that make up the view that represents the model. This is what determines how the model will be represented. This is implemented to fetch the factory provided by the associated EditorKit.
        Overrides:
        getViewFactory in class View
        Returns:
        the factory