com.xmlmind.xmledit.styledgadget

Class Box

java.lang.Object

com.xmlmind.xmledit.gadget.Gadget

com.xmlmind.xmledit.styledgadget.Box

All Implemented Interfaces:

Styleable, Styled

Direct Known Subclasses:

AbstractImageViewport, ImageLabel, PlaceholderVP, TextLineBox, ToggleCollapsed

public abstract class Box
extends Gadget
implements Styleable

Field Summary

Fields

Modifier and Type	Field and Description
static Style	DEFAULT_STYLE
protected Style	style

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

height, parent, width, x, y

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static void	drawBorder(Graphics g, Style style, int width, int height)
static void	drawBox(Graphics g, Style style, int width, int height)
static void	drawEmptyContent(Graphics g, Style style, int width, int height)
static void	drawEmptyTextContent(Graphics g, Style style, int width, int height)
static void	getContentSizeConstraints(Gadget gadget, Style style, Dimension constraints)
static Dimension	getEmptyContentSize(Gadget gadget, Style style)
static void	getEmptyContentSize(Gadget gadget, Style style, Dimension size)
int	getMarginBottom() Same as Styled.getMarginTop() but for the bottom margin.
int	getMarginTop() Returns the top margin of this object.
Style	getStyle() Returns the style of this object.
boolean	hasDynamicVerticalMargins()
void	layout(int constrainedWidth, int constrainedHeight, boolean recursive) Requests this gadget to relayout itself.
protected abstract void	layoutContent(int constrainedWidth, int constrainedHeight, boolean recursive)
void	paint(Graphics g) Paint this gadget using specified Graphics object.
protected abstract void	paintContent(Graphics g)
void	setStyle(Style style)

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

focusGained, focusLost, gadgetToPanel, gadgetToRoot, getAncestors, getBounds, getBounds, getCursor, getEventDispatcher, getFontMetrics, getGadgetPanel, getGraphics, getLocation, getLocation, getNonBreakableVerticalRanges, getRoot, getSize, getSize, getToolkit, getToolTip, grabsMouseButton, handleAppEvent, handleKeyEvent, handleMouseEvent, hasFocus, isAppEventHandler, layout, makeRectangleVisible, makeRectangleVisible, panelToGadget, print, refresh, 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

DEFAULT_STYLE

public static final Style DEFAULT_STYLE

style

protected Style style

Constructor Detail

Box

protected Box()

Box

protected Box(Style style)

Method Detail

setStyle

public void setStyle(Style style)

Specified by:

setStyle in interface Styleable

getStyle

public Style getStyle()

Description copied from interface: Styled

Returns the style of this object. May not return null.

Specified by:

getStyle in interface Styled

hasDynamicVerticalMargins

public boolean hasDynamicVerticalMargins()

Specified by:

hasDynamicVerticalMargins in interface Styled

getMarginTop

public int getMarginTop()

Description copied from interface: Styled

Returns the top margin of this object. Unlike Style.marginTop, the returned value is not a static one and may depend on the contents of this object.

This method is needed to implement collapsed vertical margins in the case of nested boxes.

Specified by:

getMarginTop in interface Styled

getMarginBottom

public int getMarginBottom()

Description copied from interface: Styled

Same as Styled.getMarginTop() but for the bottom margin.

Specified by:

getMarginBottom in interface Styled

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.

Specified by:

layout in class Gadget

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.

layoutContent

protected abstract void layoutContent(int constrainedWidth,
                                      int constrainedHeight,
                                      boolean recursive)

paint

public void paint(Graphics g)

Description copied from class: Gadget

Paint this gadget using specified Graphics object.

One cannot assume that any of the attributes of the Graphics object (background, foreground, font, etc) is properly set.

Specified by:

paint in class Gadget

paintContent

protected abstract void paintContent(Graphics g)

drawBox

public static final void drawBox(Graphics g,
                                 Style style,
                                 int width,
                                 int height)

drawBorder

public static final void drawBorder(Graphics g,
                                    Style style,
                                    int width,
                                    int height)

getContentSizeConstraints

public static final void getContentSizeConstraints(Gadget gadget,
                                                   Style style,
                                                   Dimension constraints)

drawEmptyContent

public static final void drawEmptyContent(Graphics g,
                                          Style style,
                                          int width,
                                          int height)

drawEmptyTextContent

public static final void drawEmptyTextContent(Graphics g,
                                              Style style,
                                              int width,
                                              int height)

getEmptyContentSize

public static final Dimension getEmptyContentSize(Gadget gadget,
                                                  Style style)

getEmptyContentSize

public static final void getEmptyContentSize(Gadget gadget,
                                             Style style,
                                             Dimension size)