com.xmlmind.xmledit.styledview

Class StyledTreeView

java.lang.Object

com.xmlmind.xmledit.gadget.Gadget

com.xmlmind.xmledit.gadget.GadgetContainer

com.xmlmind.xmledit.view.TreeView

com.xmlmind.xmledit.styledview.StyledTreeView

All Implemented Interfaces:

Command, CollapsibleGadget, ElementViewBase, ElementViewPartBase, Styleable, Styled, StyledView, TextLines, StyledElementView, StyledElementViewPart, ElementView, ElementViewPart, NodeView, NodeViewPart

Direct Known Subclasses:

ColumnView

public class StyledTreeView
extends TreeView
implements StyledElementView, StyledElementViewPart, TextLines

Nested Class Summary

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

GadgetContainer.Side

Nested classes/interfaces inherited from interface com.xmlmind.xmledit.styled.StyledView

StyledView.Display

Nested classes/interfaces inherited from interface com.xmlmind.xmledit.styledview.StyledElementViewPart

StyledElementViewPart.Role

Field Summary

Fields inherited from class com.xmlmind.xmledit.view.TreeView

collapsed, element, settings

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

Constructor and Description
StyledTreeView(Element element, boolean isInline, Style style)

Method Summary

Modifier and Type	Method and Description
void	detachingViewFromModel(Document document, int viewIndex) Invoked to signal the gadget that the styled view of an element it is part of is being deleted (typically because the element is being deleted).
StyledView.Display	getDisplay() Returns the CSS display used for this view of an element.
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.
int	getMarginBottom() Same as Styled.getMarginTop() but for the bottom margin.
int	getMarginTop() Returns the top margin of this object.
StyledElementViewPart.Role	getRole() Returns the role of this gadget as a part of the styled view of an element.
Style	getStyle() Returns the style of this object.
StyledElementView	getStyledElementView() Returns the styled element view this gadget is part of.
String	getViewToolTip() Returns the tooltip, if any, to be displayed by this view of an element.
boolean	hasDynamicVerticalMargins()
void	initView(ViewParameters param, ViewParameters paramBefore, Style styleBefore, ViewParameters paramAfter, Style styleAfter, StyledViewFactory viewFactory) Creates one or more Gadgets, themselves implementing the StyledElementViewPart interface, which are used to render an element graphically on screen.
boolean	isCustomView() Returns true if this view is a custom replacement for the normal view of an element; false otherwise.
boolean	isInlineDisplay() Returns true if the display returned by StyledView.getDisplay() is an inline-like display; false if it is a block-like display.
protected void	paint(Graphics g, Color backgroundColor)
void	setStyle(Style style)

Methods inherited from class com.xmlmind.xmledit.view.TreeView

addChildViewGadgets, detachingFromModel, executeCommand, getElement, getElementView, getGadgets, getModel, getNonBreakableVerticalRanges, getSettings, getSizeConstraints, getView, grabsMouseButton, handleMouseEvent, isCollapsed, isCollapsible, isTreeView, isTreeViewContainer, layout, paint, paintRelayout, prepareCommand, print, removeChildViewGadgets, setCollapsed

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

addChild, findGadgetAt, getChild, getChildCount, getChildren, 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, handleAppEvent, handleKeyEvent, hasFocus, isAppEventHandler, layout, makeRectangleVisible, makeRectangleVisible, panelToGadget, refresh, relayout, relayout, repaint, repaint, requestFocus

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.xmlmind.xmledit.view.ElementView

addChildViewGadgets, getElement, isTreeView, isTreeViewContainer, removeChildViewGadgets

Methods inherited from interface com.xmlmind.xmledit.view.NodeView

detachingFromModel, getGadgets, getModel

Methods inherited from interface com.xmlmind.xmledit.view.ElementViewPart

getElementView

Methods inherited from interface com.xmlmind.xmledit.view.NodeViewPart

getView

Methods inherited from interface com.xmlmind.xmledit.control.Command

copy

Constructor Detail

StyledTreeView

public StyledTreeView(Element element,
                      boolean isInline,
                      Style style)

Method Detail

paint

protected void paint(Graphics g,
                     Color backgroundColor)

Overrides:

paint in class TreeView

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

initView

public void initView(ViewParameters param,
                     ViewParameters paramBefore,
                     Style styleBefore,
                     ViewParameters paramAfter,
                     Style styleAfter,
                     StyledViewFactory viewFactory)

Description copied from interface: StyledElementView

Creates one or more Gadgets, themselves implementing the StyledElementViewPart interface, which are used to render an element graphically on screen.

Specified by:

initView in interface StyledElementView

isCustomView

public boolean isCustomView()

Description copied from interface: ElementViewBase

Returns true if this view is a custom replacement for the normal view of an element; false otherwise.

Specified by:

isCustomView in interface ElementViewBase

getStyledElementView

public StyledElementView getStyledElementView()

Description copied from interface: StyledElementViewPart

Returns the styled element view this gadget is part of.

Specified by:

getStyledElementView in interface StyledElementViewPart

getRole

public StyledElementViewPart.Role getRole()

Description copied from interface: StyledElementViewPart

Returns the role of this gadget as a part of the styled view of an element.

Specified by:

getRole in interface StyledElementViewPart

detachingViewFromModel

public void detachingViewFromModel(Document document,
                                   int viewIndex)

Description copied from interface: StyledElementViewPart

Invoked to signal the gadget that the styled view of an element it is part of is being deleted (typically because the element is being deleted).

Specified by:

detachingViewFromModel in interface StyledElementViewPart

getDisplay

public StyledView.Display getDisplay()

Description copied from interface: StyledView

Returns the CSS display used for this view of an element.

Specified by:

getDisplay in interface StyledView

isInlineDisplay

public boolean isInlineDisplay()

Description copied from interface: StyledView

Returns true if the display returned by StyledView.getDisplay() is an inline-like display; false if it is a block-like display.

Specified by:

isInlineDisplay in interface StyledView

getViewToolTip

public String getViewToolTip()

Description copied from interface: StyledView

Returns the tooltip, if any, to be displayed by this view of an element. May return null. May return HTML (starts with "<html>") rather than plain text.

Specified by:

getViewToolTip in interface StyledView

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