Package org.loboevolution.html.renderer

Class RBlockViewport

java.lang.Object

org.loboevolution.html.renderer.RRectangle

org.loboevolution.html.renderer.RBlockViewport

All Implemented Interfaces:

BoundableRenderable, RCollection, Renderable

public class RBlockViewport
extends RRectangle

A substantial portion of the HTML rendering logic of the package can be found in this class. This class is in charge of laying out the DOM subtree of a node, usually on behalf of an RBlock. It creates a renderer subtree consisting of RLine's or RBlock's. RLine's in turn contain RWord's and so on. This class also happens to be used as an RBlock scrollable viewport.

Field Summary

Fields

Modifier and Type	Field	Description
protected final RenderableContainer	container
protected final FrameContext	frameContext
protected boolean	layoutUpTreeCanBeInvalidated
protected final ModelNode	modelNode
protected RCollection	originalParent
protected RCollection	parent
protected final HtmlRendererContext	rendererContext
protected static final Color	SELECTION_COLOR	Constant SELECTION_COLOR
protected static final Color	SELECTION_XOR	Constant SELECTION_XOR
protected final UserAgentContext	userAgentContext
static final Insets	ZERO_INSETS	Constant ZERO_INSETS

Fields inherited from interface org.loboevolution.html.renderer.Renderable

EMPTY_ARRAY

Constructor Summary

Constructors

Constructor	Description
RBlockViewport(RBlockInfo info, RenderableContainer container, RCollection parent)	Constructs an HtmlBlockLayout.

Method Summary

Modifier and Type	Method	Description
protected void	addLineBreak(ModelNode startNode, int breakType)	addLineBreak.
protected void	addRenderableToLineCheckStyle(RElement renderable, HTMLElementImpl element)	Checks property 'float' and in some cases attribute 'align'.
void	alignX(int alignXPercent, int canvasWidth, Insets paddingInsets)	Applies any horizonal aLignment.
void	alignY(int alignYPercent, int canvasHeight, Insets paddingInsets)	Applies vertical alignment.
void	blur()	blur.
boolean	contains(int x, int y)	contains.
boolean	extractSelectionText(StringBuilder buffer, boolean isSelection, RenderableSpot startPoint, RenderableSpot endPoint)	extractSelectionText.
void	focus()	focus.
Color	getBlockBackgroundColor()	getBlockBackgroundColor.
Rectangle	getBounds()	getBounds.
Rectangle	getClipBounds()	getClipBounds.
Rectangle	getClipBoundsWithoutInsets()	getClipBoundsWithoutInsets.
int	getDeclaredHeightImpl(HTMLElementImpl element, int availHeight)	getDeclaredHeightImpl.
int	getDeclaredWidthImpl(HTMLElementImpl element, int availWidth)	getDeclaredWidthImpl.
FloatingInfo	getExportableFloatingInfo()	getExportableFloatingInfo.
int	getFirstBaselineOffset()	getFirstBaselineOffset.
int	getFirstLineHeight()	getFirstLineHeight.
Point	getGUIPoint(int clientX, int clientY)	getGUIPoint.
RenderableSpot	getLowestRenderableSpot(int x, int y)	getLowestRenderableSpot.
ModelNode	getModelNode()	getModelNode.
Point	getOrigin()	getOrigin.
RCollection	getOriginalOrCurrentParent()	getOriginalOrCurrentParent.
RCollection	getOriginalParent()	getOriginalParent.
Point	getOriginRelativeTo(RCollection ancestor)	getOriginRelativeTo.
Point	getOriginRelativeToAbs(RCollection ancestor)	getOriginRelativeToAbs.
Point	getOriginRelativeToNoScroll(RCollection ancestor)	getOriginRelativeToNoScroll.
RCollection	getParent()	getParent.
RRectangle	getRectangle()
BoundableRenderable	getRenderable(int x, int y)	getRenderable.
BoundableRenderable	getRenderable(Point point)	getRenderable.
Point	getRenderablePoint(int guiX, int guiY)	getRenderablePoint.
List<Renderable>	getRenderables()	getRenderables.
List<Renderable>	getRenderables(int pointx, int pointy)	getRenderables.
Dimension	getSize()	getSize.
Rectangle	getVisualBounds()	getVisualBounds.
int	getVisualHeight()	getVisualHeight.
int	getVisualWidth()	getVisualWidth.
void	invalidateLayoutDeep()	invalidateLayoutDeep.
void	invalidateLayoutLocal()	invalidateLayoutLocal.
final void	invalidateLayoutUpTree()	invalidateLayoutUpTree.
boolean	isContainedByNode()	isContainedByNode.
boolean	isDelegated()	isDelegated.
boolean	isValid()	isValid.
void	layout(int desiredWidth, int desiredHeight, Insets paddingInsets, int yLimit, FloatingBounds floatBounds, boolean sizeOnly)	Builds the layout/renderer tree from scratch.
void	layoutChildFlex(HTMLElementImpl markupElement)	layoutChildFlex.
protected final void	layoutList(HTMLElementImpl markupElement)	layoutList.
protected final void	layoutListItem(HTMLElementImpl markupElement)	layoutListItem.
protected void	layoutMarkup(NodeImpl node)	layoutMarkup.
protected final void	layoutRBlock(HTMLElementImpl markupElement)	layoutRBlock.
void	layoutRFlex(HTMLElementImpl markupElement)	layoutRFlex.
void	layoutRInlineBlock(HTMLElementImpl markupElement)	layoutRInlineBlock.
protected final void	layoutRTable(HTMLElementImpl markupElement)	layoutRTable.
void	markLayoutValid()	markLayoutValid.
boolean	onDoubleClick(MouseEvent event, int x, int y)	onDoubleClick.
boolean	onMouseClick(MouseEvent event, int x, int y)	onMouseClick.
boolean	onMouseDisarmed(MouseEvent event)	onMouseDisarmed.
void	onMouseMoved(MouseEvent event, int x, int y, boolean triggerEvent, ModelNode limit)	onMouseMoved.
void	onMouseOut(MouseEvent event, int x, int y, ModelNode limit)	onMouseOut.
boolean	onMousePressed(MouseEvent event, int x, int y)	onMousePressed.
boolean	onMouseReleased(MouseEvent event, int x, int y)	onMouseReleased.
void	onMouseScroll()
boolean	onRightClick(MouseEvent event, int x, int y)	onRightClick.
void	paint(Graphics gIn)	paint.
boolean	paintSelection(Graphics g, boolean inSelection, RenderableSpot startPoint, RenderableSpot endPoint)	paintSelection.
final void	paintTranslated(Graphics g)	paintTranslated.
void	positionDelayed()	positionDelayed.
protected final void	positionRElement(HTMLElementImpl markupElement, RElement renderable, boolean usesAlignAttribute, boolean obeysFloats, boolean alignCenterAttribute)	positionRElement.
void	relayout()	relayout.
void	relayoutIfValid()	relayoutIfValid.
void	repaint()	repaint.
void	repaint(int x, int y, int width, int height)	repaint.
void	setOriginalParent(RCollection origParent)	setOriginalParent.
void	setParent(RCollection parent)	setParent.
String	toString()
void	updateWidgetBounds(int guiX, int guiY)	updateWidgetBounds.

Methods inherited from class org.loboevolution.html.renderer.RRectangle

setBounds, setOrigin

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.loboevolution.html.renderer.BoundableRenderable

contains, getBounds, getGUIPoint, getHeight, getModelNode, getOrdinal, getOrigin, getOriginalOrCurrentParent, getOriginalParent, getOriginRelativeTo, getOriginRelativeToAbs, getOriginRelativeToNoScroll, getParent, getRectangle, getRenderablePoint, getSize, getVisualBounds, getWidth, getX, getY, getZIndex, invalidateLayoutUpTree, isDelegated, onMouseScroll, paintTranslated, relayout, repaint, repaint, setBounds, setDelegator, setHeight, setOrdinal, setOrigin, setOriginalParent, setParent, setWidth, setX, setY

Methods inherited from interface org.loboevolution.html.renderer.Renderable

findHtmlRenderable, isFixed

Field Details

rendererContext

protected final HtmlRendererContext rendererContext

userAgentContext

protected final UserAgentContext userAgentContext

container

protected final RenderableContainer container

frameContext

protected final FrameContext frameContext

ZERO_INSETS

public static final Insets ZERO_INSETS

Constant ZERO_INSETS

SELECTION_COLOR

protected static final Color SELECTION_COLOR

Constant SELECTION_COLOR

SELECTION_XOR

protected static final Color SELECTION_XOR

Constant SELECTION_XOR

layoutUpTreeCanBeInvalidated

protected boolean layoutUpTreeCanBeInvalidated

modelNode

protected final ModelNode modelNode

originalParent

protected RCollection originalParent

parent

protected RCollection parent

Constructor Details

RBlockViewport

public RBlockViewport(RBlockInfo info,
 RenderableContainer container,
 RCollection parent)

Constructs an HtmlBlockLayout.

Parameters:

info - a RBlockInfo object.

Method Details

addLineBreak

protected void addLineBreak(ModelNode startNode,
 int breakType)

addLineBreak.

Parameters:

startNode - a ModelNode object.

breakType - a Integer object.

addRenderableToLineCheckStyle

protected void addRenderableToLineCheckStyle(RElement renderable,
 HTMLElementImpl element)

Checks property 'float' and in some cases attribute 'align'.

Parameters:

renderable - a RElement object.

element - a HTMLElementImpl object.

alignX

public void alignX(int alignXPercent,
 int canvasWidth,
 Insets paddingInsets)

Applies any horizonal aLignment. It may adjust height if necessary.

Parameters:

alignXPercent - a Integer object.

canvasWidth - The new width of the viewport. It could be different to the previously calculated width.

paddingInsets - a Insets object.

alignY

public void alignY(int alignYPercent,
 int canvasHeight,
 Insets paddingInsets)

Applies vertical alignment.

Parameters:

alignYPercent - a Integer object.

canvasHeight - a Integer object.

paddingInsets - a Insets object.

getExportableFloatingInfo

public FloatingInfo getExportableFloatingInfo()

getExportableFloatingInfo.

Returns:

a FloatingInfo object.

getFirstBaselineOffset

public int getFirstBaselineOffset()

getFirstBaselineOffset.

Returns:

a Integer object.

getFirstLineHeight

public int getFirstLineHeight()

getFirstLineHeight.

Returns:

a Integer object.

getLowestRenderableSpot

public RenderableSpot getLowestRenderableSpot(int x,
 int y)

getLowestRenderableSpot.

Parameters:

x - a Integer object.

y - a Integer object.

Returns:

a RenderableSpot object.

getRenderable

public BoundableRenderable getRenderable(int x,
 int y)

getRenderable.

Specified by:

getRenderable in interface RCollection

Parameters:

x - a Integer object.

y - a Integer object.

Returns:

a BoundableRenderable object.

getRenderable

public BoundableRenderable getRenderable(Point point)

getRenderable.

Parameters:

point - a Point object.

Returns:

a BoundableRenderable object.

getRenderables

public List<Renderable> getRenderables()

getRenderables.

Returns:

a List object.

getRenderables

public List<Renderable> getRenderables(int pointx,
 int pointy)

getRenderables.

Parameters:

pointx - a Integer object.

pointy - a Integer object.

Returns:

a List object.

invalidateLayoutLocal

public void invalidateLayoutLocal()

invalidateLayoutLocal.

isContainedByNode

public boolean isContainedByNode()

isContainedByNode.

Returns:

a boolean.

layout

public void layout(int desiredWidth,
 int desiredHeight,
 Insets paddingInsets,
 int yLimit,
 FloatingBounds floatBounds,
 boolean sizeOnly)

Builds the layout/renderer tree from scratch. Note: Returned dimension needs to be actual size needed for rendered content, not the available container size. This is relied upon by table layout.

Parameters:

desiredWidth - a Integer object.

desiredHeight - a Integer object.

paddingInsets - a Insets object.

yLimit - If other than -1, layout will throw SizeExceededException in the event that the layout goes beyond this y-coordinate point.

floatBounds - a FloatingBounds object.

sizeOnly - a boolean.

layoutList

protected final void layoutList(HTMLElementImpl markupElement)

layoutList.

Parameters:

markupElement - a HTMLElementImpl object.

layoutListItem

protected final void layoutListItem(HTMLElementImpl markupElement)

layoutListItem.

Parameters:

markupElement - a HTMLElementImpl object.

layoutMarkup

protected void layoutMarkup(NodeImpl node)

layoutMarkup.

Parameters:

node - a NodeImpl object.

layoutRBlock

protected final void layoutRBlock(HTMLElementImpl markupElement)

layoutRBlock.

Parameters:

markupElement - a HTMLElementImpl object.

layoutRTable

protected final void layoutRTable(HTMLElementImpl markupElement)

layoutRTable.

Parameters:

markupElement - a HTMLElementImpl object.

layoutRInlineBlock

public void layoutRInlineBlock(HTMLElementImpl markupElement)

layoutRInlineBlock.

Parameters:

markupElement - a HTMLElementImpl object.

layoutRFlex

public void layoutRFlex(HTMLElementImpl markupElement)

layoutRFlex.

Parameters:

markupElement - a HTMLElementImpl object.

layoutChildFlex

public void layoutChildFlex(HTMLElementImpl markupElement)

layoutChildFlex.

Parameters:

markupElement - a HTMLElementImpl object.

onDoubleClick

public boolean onDoubleClick(MouseEvent event,
 int x,
 int y)

onDoubleClick.

Specified by:

onDoubleClick in interface BoundableRenderable

Parameters:

event - a MouseEvent object.

x - a Integer object.

y - a Integer object.

Returns:

a boolean.

onMouseClick

public boolean onMouseClick(MouseEvent event,
 int x,
 int y)

onMouseClick.

Specified by:

onMouseClick in interface BoundableRenderable

Parameters:

event - a MouseEvent object.

x - a Integer object.

y - a Integer object.

Returns:

a boolean.

onMouseDisarmed

public boolean onMouseDisarmed(MouseEvent event)

onMouseDisarmed.

Specified by:

onMouseDisarmed in interface BoundableRenderable

Parameters:

event - a MouseEvent object.

Returns:

a boolean.

onMousePressed

public boolean onMousePressed(MouseEvent event,
 int x,
 int y)

onMousePressed.

Specified by:

onMousePressed in interface BoundableRenderable

Parameters:

event - a MouseEvent object.

x - a Integer object.

y - a Integer object.

Returns:

a boolean.

onMouseReleased

public boolean onMouseReleased(MouseEvent event,
 int x,
 int y)

onMouseReleased.

Specified by:

onMouseReleased in interface BoundableRenderable

Parameters:

event - a MouseEvent object.

x - a Integer object.

y - a Integer object.

Returns:

a boolean.

paint

public void paint(Graphics gIn)

paint.

Parameters:

gIn - a Graphics object.

positionRElement

protected final void positionRElement(HTMLElementImpl markupElement,
 RElement renderable,
 boolean usesAlignAttribute,
 boolean obeysFloats,
 boolean alignCenterAttribute)

positionRElement.

Parameters:

markupElement - a HTMLElementImpl object.

renderable - a RElement object.

usesAlignAttribute - a boolean.

obeysFloats - a boolean.

alignCenterAttribute - a boolean.

toString

public String toString()

Overrides:

toString in class Object

getClipBounds

public Rectangle getClipBounds()

getClipBounds.

Returns:

a Rectangle object.

getVisualHeight

public int getVisualHeight()

getVisualHeight.

Specified by:

getVisualHeight in interface BoundableRenderable

Returns:

a Integer object.

getVisualWidth

public int getVisualWidth()

getVisualWidth.

Specified by:

getVisualWidth in interface BoundableRenderable

Returns:

a Integer object.

positionDelayed

public void positionDelayed()

positionDelayed.

blur

public void blur()

blur.

Specified by:

blur in interface RCollection

getClipBoundsWithoutInsets

public Rectangle getClipBoundsWithoutInsets()

getClipBoundsWithoutInsets.

Specified by:

getClipBoundsWithoutInsets in interface RCollection

Returns:

a Rectangle object.

extractSelectionText

public boolean extractSelectionText(StringBuilder buffer,
 boolean isSelection,
 RenderableSpot startPoint,
 RenderableSpot endPoint)

extractSelectionText.

Specified by:

extractSelectionText in interface BoundableRenderable

Parameters:

buffer - a StringBuilder object.

isSelection - a boolean.

startPoint - a RenderableSpot object.

endPoint - a RenderableSpot object.

Returns:

a boolean.

focus

public void focus()

focus.

Specified by:

focus in interface RCollection

invalidateLayoutDeep

public void invalidateLayoutDeep()

invalidateLayoutDeep.

Specified by:

invalidateLayoutDeep in interface RCollection

onMouseMoved

public void onMouseMoved(MouseEvent event,
 int x,
 int y,
 boolean triggerEvent,
 ModelNode limit)

onMouseMoved.

Specified by:

onMouseMoved in interface BoundableRenderable

Parameters:

event - a MouseEvent object.

x - a Integer object.

y - a Integer object.

triggerEvent - a boolean.

limit - a ModelNode object.

onMouseOut

public void onMouseOut(MouseEvent event,
 int x,
 int y,
 ModelNode limit)

onMouseOut.

Specified by:

onMouseOut in interface BoundableRenderable

Parameters:

event - a MouseEvent object.

x - a Integer object.

y - a Integer object.

limit - a ModelNode object.

onRightClick

public boolean onRightClick(MouseEvent event,
 int x,
 int y)

onRightClick.

Specified by:

onRightClick in interface BoundableRenderable

Parameters:

event - a MouseEvent object.

x - a Integer object.

y - a Integer object.

Returns:

a boolean.

paintSelection

public boolean paintSelection(Graphics g,
 boolean inSelection,
 RenderableSpot startPoint,
 RenderableSpot endPoint)

paintSelection.

Specified by:

paintSelection in interface BoundableRenderable

Parameters:

g - a Graphics object.

inSelection - a boolean.

startPoint - a RenderableSpot object.

endPoint - a RenderableSpot object.

Returns:

a boolean.

updateWidgetBounds

public void updateWidgetBounds(int guiX,
 int guiY)

updateWidgetBounds.

Updates bounds of all descendent's GUI components, based on root bounds.

Specified by:

updateWidgetBounds in interface RCollection

Parameters:

guiX - a Integer object.

guiY - a Integer object.

getDeclaredWidthImpl

public int getDeclaredWidthImpl(HTMLElementImpl element,
 int availWidth)

getDeclaredWidthImpl.

Parameters:

element - a HTMLElementImpl object.

availWidth - a Integer object.

Returns:

a Integer object.

getDeclaredHeightImpl

public int getDeclaredHeightImpl(HTMLElementImpl element,
 int availHeight)

getDeclaredHeightImpl.

Parameters:

element - a HTMLElementImpl object.

availHeight - a Integer object.

Returns:

a Integer object.

contains

public boolean contains(int x,
 int y)

contains.

Specified by:

contains in interface BoundableRenderable

Parameters:

x - a Integer object.

y - a Integer object.

Returns:

a boolean.

getBlockBackgroundColor

public Color getBlockBackgroundColor()

getBlockBackgroundColor.

Returns:

a Color object.

getBounds

public Rectangle getBounds()

getBounds.

Specified by:

getBounds in interface BoundableRenderable

Returns:

a Rectangle object.

getVisualBounds

public Rectangle getVisualBounds()

getVisualBounds.

Specified by:

getVisualBounds in interface BoundableRenderable

Returns:

a Rectangle object.

getGUIPoint

public Point getGUIPoint(int clientX,
 int clientY)

getGUIPoint.

Specified by:

getGUIPoint in interface BoundableRenderable

Parameters:

clientX - a Integer object.

clientY - a Integer object.

Returns:

a Point object.

getModelNode

public ModelNode getModelNode()

getModelNode.

Specified by:

getModelNode in interface BoundableRenderable

Specified by:

getModelNode in interface Renderable

Returns:

a ModelNode object.

getOrigin

public Point getOrigin()

getOrigin.

Specified by:

getOrigin in interface BoundableRenderable

Returns:

a Point object.

getOriginalOrCurrentParent

public RCollection getOriginalOrCurrentParent()

getOriginalOrCurrentParent.

Specified by:

getOriginalOrCurrentParent in interface BoundableRenderable

Returns:

a RCollection object.

getOriginalParent

public RCollection getOriginalParent()

getOriginalParent.

This is the parent based on the original element hierarchy.

Specified by:

getOriginalParent in interface BoundableRenderable

Returns:

a RCollection object.

getOriginRelativeTo

public Point getOriginRelativeTo(RCollection ancestor)

getOriginRelativeTo.

Specified by:

getOriginRelativeTo in interface BoundableRenderable

Parameters:

ancestor - a RCollection object.

Returns:

a Point object.

getOriginRelativeToNoScroll

public Point getOriginRelativeToNoScroll(RCollection ancestor)

getOriginRelativeToNoScroll.

Specified by:

getOriginRelativeToNoScroll in interface BoundableRenderable

Parameters:

ancestor - a RCollection object.

Returns:

a Point object.

getOriginRelativeToAbs

public Point getOriginRelativeToAbs(RCollection ancestor)

getOriginRelativeToAbs.

Specified by:

getOriginRelativeToAbs in interface BoundableRenderable

Parameters:

ancestor - a RCollection object.

Returns:

a Point object.

getParent

public RCollection getParent()

getParent.

Specified by:

getParent in interface BoundableRenderable

Returns:

a RCollection object.

getRenderablePoint

public Point getRenderablePoint(int guiX,
 int guiY)

getRenderablePoint.

Specified by:

getRenderablePoint in interface BoundableRenderable

Parameters:

guiX - a Integer object.

guiY - a Integer object.

Returns:

a Point object.

getSize

public Dimension getSize()

getSize.

Specified by:

getSize in interface BoundableRenderable

Returns:

a Dimension object.

invalidateLayoutUpTree

public final void invalidateLayoutUpTree()

invalidateLayoutUpTree.

Invalidates this Renderable and its parent (i.e. all ancestors).

Specified by:

invalidateLayoutUpTree in interface BoundableRenderable

isValid

public boolean isValid()

isValid.

Returns:

a boolean.

markLayoutValid

public void markLayoutValid()

markLayoutValid.

onMouseScroll

public void onMouseScroll()

Specified by:

onMouseScroll in interface BoundableRenderable

paintTranslated

public final void paintTranslated(Graphics g)

paintTranslated.

Specified by:

paintTranslated in interface BoundableRenderable

Parameters:

g - a Graphics object.

relayout

public void relayout()

relayout.

Invalidates the current Renderable (which invalidates its ancestors) and then requests the top level GUI container to do the layout and repaint. It's safe to call this method outside the GUI thread.

Specified by:

relayout in interface BoundableRenderable

relayoutIfValid

public void relayoutIfValid()

relayoutIfValid.

repaint

public void repaint()

repaint.

Specified by:

repaint in interface BoundableRenderable

repaint

public void repaint(int x,
 int y,
 int width,
 int height)

repaint.

Specified by:

repaint in interface BoundableRenderable

Parameters:

x - a Integer object.

y - a Integer object.

width - a Integer object.

height - a Integer object.

setOriginalParent

public void setOriginalParent(RCollection origParent)

setOriginalParent.

Specified by:

setOriginalParent in interface BoundableRenderable

Parameters:

origParent - a RCollection object.

setParent

public void setParent(RCollection parent)

setParent.

Specified by:

setParent in interface BoundableRenderable

Parameters:

parent - a RCollection object.

isDelegated

public boolean isDelegated()

Description copied from interface: BoundableRenderable

isDelegated.

Specified by:

isDelegated in interface BoundableRenderable

Returns:

a boolean.

getRectangle

public RRectangle getRectangle()

Specified by:

getRectangle in interface BoundableRenderable