com.inet.html.views
Class BoxPainter

java.lang.Object
  com.inet.html.views.BackgroundPainter
      com.inet.html.views.BoxPainter

All Implemented Interfaces:

IBackgroundPainter, IBoxPainter

Direct Known Subclasses:

TableBoxPainter

public class BoxPainter
extends BackgroundPainter
implements IBoxPainter

This is the basic box painter. It reads the required borders, margins and padding itself. NOTE: BoxPainter are dedicated to a view in the means of relative values. Nevertheless it can be bound to a model element to reuse the painter for in-line boxes or content painters. http://www.w3.org/TR/1998/REC-CSS2/box.html

Field Summary

Fields inherited from interface com.inet.html.views.IBoxPainter

EMPTY_INSETS, PAINT_MODE_CENTER, PAINT_MODE_LEFTEDGE, PAINT_MODE_NORMAL, PAINT_MODE_RIGHTEDGE

Method Summary

static IBoxPainter	createBoxPainter(BoxView view) Creates a box painter for a specified view.
static IBoxPainter	createBoxPainter(BoxView parent, BoxView paintRef, javax.swing.text.Element descendant) Creates a box painter for a specified view.
static IBoxPainter	createBoxPainter(BoxView parent, javax.swing.text.Element descendant) Creates a box painter for a specified view.
com.inet.html.parser.converter.ColorValue	getBorderBottomColor() Returns the color of the bottom border, may be null
java.awt.Insets	getBorderInsets() Get the border sizes set by html or CSS.
com.inet.html.parser.converter.ColorValue	getBorderLeftColor() Returns the color of the left border, may be null
com.inet.html.parser.converter.ColorValue	getBorderRightColor() Returns the color of the right border, may be null
java.awt.Insets	getBorderStyles() Get the border styles set by CSS.
com.inet.html.parser.converter.ColorValue	getBorderTopColor() Returns the color of the top border, may be null
int	getBottomBorderPadding() Returns the bottom border width + padding width
int	getLeftBorderPadding() Returns the distance between the outer border and the content area on the left side
java.awt.Insets	getMargins() Get the CSS margins.
java.awt.Insets	getPadding() This are the padding values set by the CSS.
int	getRightBorderPadding() Returns the right border width + padding width
int	getTopBorderPadding() Returns the top border width + padding width
int	getTotalHeightGain() Returns the total difference in width between the content and the box around the margin
int	getTotalLeftGain() Distance between the margins outer border to the left end the left border of the content
int	getTotalTopGain() Distance between the margins outer border on the top and the top border of the content
int	getTotalWidthGain() Returns the total difference in width between the content and the box around the margin
BoxView	getView() Returns the view this painter is bound to, will not be null
boolean	isRelevant() Returns true if this box painter has any visible effect (note: padding is visible as well!)
void	paint(java.awt.Graphics g, int x, int y, int width, int height, int paintMode, BoxView paintRef) Paints the box or a part of the box represented by this painter.
void	paint(java.awt.Graphics g, java.awt.Rectangle r, int paintMode, BoxView paintRef) Paints the box or a part of the box represented by this painter.
void	setBorderBottomColor(com.inet.html.parser.converter.ColorValue borderBottomColor) Sets the color of the bottom border
java.awt.Insets	setBorderInsets() Returns a mutable insets object to manipulate the border width
void	setBorderInsets(java.awt.Insets borderInsets) Sets the border insets.
void	setBorderLeftColor(com.inet.html.parser.converter.ColorValue borderLeftColor) Sets the color of the left border
void	setBorderRightColor(com.inet.html.parser.converter.ColorValue borderRightColor) Sets the color of the right border
java.awt.Insets	setBorderStyles() Returns a mutable insets object to manipulate the border styles
void	setBorderStyles(java.awt.Insets borderStyles) Sets the border styles.
void	setBorderTopColor(com.inet.html.parser.converter.ColorValue borderTopColor) Sets the color of the top border
java.awt.Insets	setMargins() Returns a mutable insets object to manipulate the margin width
void	setMargins(java.awt.Insets margins) Sets the margin insets
java.awt.Insets	setPadding() Returns a mutable insets object to manipulate the padding width
void	setPadding(java.awt.Insets padding) Sets the padding insets
void	updateRelativeValues(int parentWidth) Checks whether this view has relative paddings or margins an updates them.
void	updateRelevance() Updates the internal relevance flag.

Methods inherited from class com.inet.html.views.BackgroundPainter

getBackgroundValue, getElement, getLastPaint, getReferenceView, isInitDone, paintBackground, setBackgroundValue, setInitDone, setLastPaint, setReferenceView

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.inet.html.views.IBackgroundPainter

getBackgroundValue, getElement, getLastPaint, getReferenceView, isInitDone, paintBackground, setBackgroundValue, setInitDone, setLastPaint, setReferenceView

Method Detail

createBoxPainter

public static IBoxPainter createBoxPainter(BoxView parent,
                                           javax.swing.text.Element descendant)

Creates a box painter for a specified view.

Parameters:

parent - Parent view of the painter, will be used as a reference in case of relative values

descendant - If this is set , the painter will be registered at the parent to always paint descendants of this element. This will be used for splitted inline boxes. Note: descendant is supposed to be a descendant of the parent view's element!

Returns:

The requested box painter

createBoxPainter

public static IBoxPainter createBoxPainter(BoxView parent,
                                           BoxView paintRef,
                                           javax.swing.text.Element descendant)

Creates a box painter for a specified view.

Parameters:

parent - Parent view of the painter, will be used as a reference in case of relative values

paintRef - the first view in the flow, which will use this painter - required as a reference for seamless background images

descendant - If this is set , the painter will be registered at the parent to always paint descendants of this element. This will be used for splitted inline boxes. Note: descendant is supposed to be a descendant of the parent view's element!

Returns:

The requested box painter

createBoxPainter

public static IBoxPainter createBoxPainter(BoxView view)

Creates a box painter for a specified view.

Parameters:

view - Parent view of the painter, will be used as a reference in case of relative values of the view's element. It this element has already a painter attached, this painter will be returned. That way a painter can be used for several views in an inline layout,

Returns:

The requested box painter

updateRelativeValues

public void updateRelativeValues(int parentWidth)

Checks whether this view has relative paddings or margins an updates them.

Specified by:

updateRelativeValues in interface IBoxPainter

Parameters:

parentWidth - The width of the parent view

getPadding

public java.awt.Insets getPadding()

This are the padding values set by the CSS. WARNING: This object is immutable!

Specified by:

getPadding in interface IBoxPainter

Returns:

the view insets.

getMargins

public java.awt.Insets getMargins()

Get the CSS margins. WARNING: This object is immutable!

Specified by:

getMargins in interface IBoxPainter

Returns:

never null

getBorderInsets

public java.awt.Insets getBorderInsets()

Get the border sizes set by html or CSS. WARNING: This object is immutable!

Specified by:

getBorderInsets in interface IBoxPainter

Returns:

never null

getBorderStyles

public java.awt.Insets getBorderStyles()

Get the border styles set by CSS. WARNING: This object is immutable!

Specified by:

getBorderStyles in interface IBoxPainter

Returns:

never null

getTotalWidthGain

public int getTotalWidthGain()

Returns the total difference in width between the content and the box around the margin

Specified by:

getTotalWidthGain in interface IBoxPainter

Returns:

width in pixel

getTotalHeightGain

public int getTotalHeightGain()

Returns the total difference in width between the content and the box around the margin

Specified by:

getTotalHeightGain in interface IBoxPainter

Returns:

height in pixel

getLeftBorderPadding

public int getLeftBorderPadding()

Returns the distance between the outer border and the content area on the left side

Specified by:

getLeftBorderPadding in interface IBoxPainter

Returns:

distance in pixel

getTopBorderPadding

public int getTopBorderPadding()

Returns the top border width + padding width

Specified by:

getTopBorderPadding in interface IBoxPainter

Returns:

the top border width + padding width

getBottomBorderPadding

public int getBottomBorderPadding()

Returns the bottom border width + padding width

Specified by:

getBottomBorderPadding in interface IBoxPainter

Returns:

the bottom border width + padding width

getRightBorderPadding

public int getRightBorderPadding()

Returns the right border width + padding width

Specified by:

getRightBorderPadding in interface IBoxPainter

Returns:

the right border width + padding width

getTotalLeftGain

public int getTotalLeftGain()

Distance between the margins outer border to the left end the left border of the content

Specified by:

getTotalLeftGain in interface IBoxPainter

Returns:

distance in pixel

getTotalTopGain

public int getTotalTopGain()

Distance between the margins outer border on the top and the top border of the content

Specified by:

getTotalTopGain in interface IBoxPainter

Returns:

distance in pixel

paint

public void paint(java.awt.Graphics g,
                  java.awt.Rectangle r,
                  int paintMode,
                  BoxView paintRef)

Paints the box or a part of the box represented by this painter.
NOTE: Partial painting is required for inline boxes since these boxes are likely to span several lines

Specified by:

paint in interface IBoxPainter

Parameters:

g - the graphics to paint to

r - the area do draw to

paintMode - the paint mode constant

paintRef - the coordinate reference for inline background images

See Also:

IBoxPainter.PAINT_MODE_NORMAL, IBoxPainter.PAINT_MODE_LEFTEDGE, IBoxPainter.PAINT_MODE_CENTER, IBoxPainter.PAINT_MODE_RIGHTEDGE

paint

public void paint(java.awt.Graphics g,
                  int x,
                  int y,
                  int width,
                  int height,
                  int paintMode,
                  BoxView paintRef)

Paints the box or a part of the box represented by this painter.
NOTE: Partial painting is required for inline boxes since these boxes are likely to span several lines

Specified by:

paint in interface IBoxPainter

Parameters:

g - the graphics to paint to

x - the x coordinate of the paint area

y - the y coordinate of the paint area

width - the width coordinate of the paint area

height - the height coordinate of the paint area

paintMode - the paint mode constant

paintRef - the coordinate reference for inline background images

See Also:

IBoxPainter.PAINT_MODE_NORMAL, IBoxPainter.PAINT_MODE_LEFTEDGE, IBoxPainter.PAINT_MODE_CENTER, IBoxPainter.PAINT_MODE_RIGHTEDGE

getView

public BoxView getView()

Returns the view this painter is bound to, will not be null

Specified by:

getView in interface IBoxPainter

Returns:

the view this painter is bound to, will not be null

getBorderTopColor

public com.inet.html.parser.converter.ColorValue getBorderTopColor()

Returns the color of the top border, may be null

Specified by:

getBorderTopColor in interface IBoxPainter

Returns:

the color of the top border, may be null

getBorderLeftColor

public com.inet.html.parser.converter.ColorValue getBorderLeftColor()

Returns the color of the left border, may be null

Specified by:

getBorderLeftColor in interface IBoxPainter

Returns:

the color of the left border, may be null

getBorderRightColor

public com.inet.html.parser.converter.ColorValue getBorderRightColor()

Returns the color of the right border, may be null

Specified by:

getBorderRightColor in interface IBoxPainter

Returns:

the color of the right border, may be null

getBorderBottomColor

public com.inet.html.parser.converter.ColorValue getBorderBottomColor()

Returns the color of the bottom border, may be null

Specified by:

getBorderBottomColor in interface IBoxPainter

Returns:

the color of the bottom border, may be null

setBorderBottomColor

public void setBorderBottomColor(com.inet.html.parser.converter.ColorValue borderBottomColor)

Sets the color of the bottom border

Specified by:

setBorderBottomColor in interface IBoxPainter

Parameters:

borderBottomColor - the color of the bottom border

setBorderLeftColor

public void setBorderLeftColor(com.inet.html.parser.converter.ColorValue borderLeftColor)

Sets the color of the left border

Specified by:

setBorderLeftColor in interface IBoxPainter

Parameters:

borderLeftColor - color of the left border

setBorderRightColor

public void setBorderRightColor(com.inet.html.parser.converter.ColorValue borderRightColor)

Sets the color of the right border

Specified by:

setBorderRightColor in interface IBoxPainter

Parameters:

borderRightColor - color of the right border

setBorderTopColor

public void setBorderTopColor(com.inet.html.parser.converter.ColorValue borderTopColor)

Sets the color of the top border

Specified by:

setBorderTopColor in interface IBoxPainter

Parameters:

borderTopColor - color of the top border

isRelevant

public boolean isRelevant()

Returns true if this box painter has any visible effect (note: padding is visible as well!)

Specified by:

isRelevant in interface IBackgroundPainter

Specified by:

isRelevant in interface IBoxPainter

Overrides:

isRelevant in class BackgroundPainter

Returns:

true if this box painter has any visible effect

updateRelevance

public void updateRelevance()

Updates the internal relevance flag. This is required, if the box values were changes externally and may cause this painter to change it's relevance

Specified by:

updateRelevance in interface IBoxPainter

setBorderStyles

public void setBorderStyles(java.awt.Insets borderStyles)

Sets the border styles.

Specified by:

setBorderStyles in interface IBoxPainter

Parameters:

borderStyles - the border styles

setBorderInsets

public void setBorderInsets(java.awt.Insets borderInsets)

Sets the border insets.

Specified by:

setBorderInsets in interface IBoxPainter

Parameters:

borderInsets - the border insets

setPadding

public void setPadding(java.awt.Insets padding)

Sets the padding insets

Specified by:

setPadding in interface IBoxPainter

Parameters:

padding - the padding insets

setMargins

public void setMargins(java.awt.Insets margins)

Sets the margin insets

Specified by:

setMargins in interface IBoxPainter

Parameters:

margins - the margin insets

setBorderInsets

public java.awt.Insets setBorderInsets()

Returns a mutable insets object to manipulate the border width

Specified by:

setBorderInsets in interface IBoxPainter

Returns:

a mutable insets object to manipulate the border width

setBorderStyles

public java.awt.Insets setBorderStyles()

Returns a mutable insets object to manipulate the border styles

Specified by:

setBorderStyles in interface IBoxPainter

Returns:

a mutable insets object to manipulate the border styles

setMargins

public java.awt.Insets setMargins()

Returns a mutable insets object to manipulate the margin width

Specified by:

setMargins in interface IBoxPainter

Returns:

a mutable insets object to manipulate the margin width

setPadding

public java.awt.Insets setPadding()

Returns a mutable insets object to manipulate the padding width

Specified by:

setPadding in interface IBoxPainter

Returns:

a mutable insets object to manipulate the padding width