com.xmlmind.xmledit.styledgadget

Class TextLineContainerBox

java.lang.Object

com.xmlmind.xmledit.gadget.Gadget

com.xmlmind.xmledit.gadget.GadgetContainer

com.xmlmind.xmledit.styledgadget.ContainerBox

com.xmlmind.xmledit.styledgadget.TextLineContainerBox

All Implemented Interfaces:

Styleable, Styled, TextLines

Direct Known Subclasses:

Division, Form, Paragraph

public abstract class TextLineContainerBox
extends ContainerBox
implements TextLines

Nested Class Summary

Nested classes/interfaces inherited from class com.xmlmind.xmledit.gadget.GadgetContainer

GadgetContainer.Side

Field Summary

Fields

Modifier and Type	Field and Description
protected int	firstBaseLine
protected int	lastBaseLine

Fields inherited from class com.xmlmind.xmledit.styledgadget.ContainerBox

style

Fields inherited from class com.xmlmind.xmledit.gadget.GadgetContainer

children, NO_GADGETS

Fields inherited from class com.xmlmind.xmledit.gadget.Gadget

height, parent, width, x, y

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TextLineContainerBox()
protected	TextLineContainerBox(Style style)

Method Summary

Modifier and Type	Method and Description
int	getFirstBaseLine() Returns the baseline of first text line if any and -1 otherwise.
int	getLastBaseLine() Returns the baseline of last text line if any and -1 otherwise.
void	layout(int constrainedWidth, int constrainedHeight, boolean recursive) Requests this gadget to relayout itself.
void	paintRelayout(Gadget child, int prevWidth, int prevHeight, GadgetContainer.Side damagedSide, int damagedLength) Invoked by a child gadget when its geometry (width, height, but also for some gadgets baseline, reference point, etc) has changed.
void	refresh() Requests this gadget to relayout and repaint itself.

Methods inherited from class com.xmlmind.xmledit.styledgadget.ContainerBox

getMarginBottom, getMarginTop, getStyle, hasDynamicVerticalMargins, layoutContent, layoutEmptyContent, paint, paintContent, paintEmptyContent, print, printContent, printEmptyContent, setStyle

Methods inherited from class com.xmlmind.xmledit.gadget.GadgetContainer

addChild, findGadgetAt, getChild, getChildCount, getChildren, getNonBreakableVerticalRanges, getSizeConstraints, indexOfChild, indexOfChildAt, insertChild, isAncestorOf, paintRelayout, removeAllChildren, removeChild, removeChild, replaceChild, replaceChild

Methods inherited from class com.xmlmind.xmledit.gadget.Gadget

focusGained, focusLost, gadgetToPanel, gadgetToRoot, getAncestors, getBounds, getBounds, getCursor, getEventDispatcher, getFontMetrics, getGadgetPanel, getGraphics, getLocation, getLocation, getRoot, getSize, getSize, getToolkit, getToolTip, grabsMouseButton, handleAppEvent, handleKeyEvent, handleMouseEvent, hasFocus, isAppEventHandler, layout, makeRectangleVisible, makeRectangleVisible, panelToGadget, relayout, relayout, repaint, repaint, requestFocus

Methods inherited from class java.lang.Object

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

Field Detail

firstBaseLine

protected int firstBaseLine

lastBaseLine

protected int lastBaseLine

Constructor Detail

TextLineContainerBox

protected TextLineContainerBox()

TextLineContainerBox

protected TextLineContainerBox(Style style)

Method Detail

getFirstBaseLine

public int getFirstBaseLine()

Description copied from interface: TextLines

Returns the baseline of first text line if any and -1 otherwise. This value is the distance in pixels from top of the gadget to the baseline of first text line.

Specified by:

getFirstBaseLine in interface TextLines

getLastBaseLine

public int getLastBaseLine()

Description copied from interface: TextLines

Returns the baseline of last text line if any and -1 otherwise. This value is the distance in pixels from top of the gadget to the baseline of last text line.

Specified by:

getLastBaseLine in interface TextLines

refresh

public void refresh()

Description copied from class: Gadget

Requests this gadget to relayout and repaint itself.

This default implementation assumes that if, after the relayout, this gadget has not changed its width and height, a repaint is sufficient and its parent doesn't need to be notified.

Overrides:

refresh in class Gadget

layout

public void layout(int constrainedWidth,
                   int constrainedHeight,
                   boolean recursive)

Description copied from class: Gadget

Requests this gadget to relayout itself.

This gadget responds by recomputing and updating its width and height.

Overrides:

layout in class ContainerBox

Parameters:

constrainedWidth - A stretchable gadget might be able to adapt its size to this constrained width. A negative or null value means not constrained.

constrainedHeight - A stretchable gadget might be able to adapt its size to this constrained height. A negative or null value means not constrained.

recursive - If true, recursively layout children too.

paintRelayout

public void paintRelayout(Gadget child,
                          int prevWidth,
                          int prevHeight,
                          GadgetContainer.Side damagedSide,
                          int damagedLength)

Description copied from class: GadgetContainer

Invoked by a child gadget when its geometry (width, height, but also for some gadgets baseline, reference point, etc) has changed.

This parent gadget must at least respond by repainting its child but generally this parent gadget has to ``refresh'' itself.

This default implementation is a kind of light-weight Gadget.refresh() where the relayout is not recursive. It should be redefined by a faster, more container specific, version.

This default implementation assumes that if, after the relayout, this container has not changed its width and height, a repaint is sufficient and its own parent doesn't need to be notified.

Overrides:

paintRelayout in class GadgetContainer

Parameters:

child - the child that invoked this method

prevWidth - child width before the relayout

prevHeight - child height before the relayout

damagedSide - the side, if any, that was expanded or shrinked

damagedLength - If damagedSide is GadgetContainer.Side.TOP, it is sufficient to repaint (0, 0, width, damagedLength).

If damagedSide is GadgetContainer.Side.BOTTOM, it is sufficient to repaint (0, height-damagedLength, width, damagedLength).

If damagedSide is GadgetContainer.Side.LEFT, it is sufficient to repaint (0, 0, damagedLength, height).

If damagedSide is GadgetContainer.Side.RIGHT, it is sufficient to repaint (width-damagedLength, 0, damagedLength, height).

If damagedSide is GadgetContainer.Side.NONE, (damagedLength is meaningless) repaint the whole child.