uk.ac.ox.cs.diadem.webapi.css

Interface StyledOverlayBuilder

public interface StyledOverlayBuilder

Builder to construct overlays in DOMWindow, to display informations

Author:

Giovanni Grasso (giovannigrasso@gmail.com) Oxford University, Department of Computer Science

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	StyledOverlayBuilder.Rect

Method Summary

Modifier and Type	Method and Description
void	addFixedHTMLBox(String innerHTML, StyledOverlayBuilder.Rect boundingRect, String... classNames)
void	addInfobox(StyledNode referenceNode, org.apache.commons.lang3.tuple.Pair<String,String> keyValues, String... classNames) Decorates this overlay with an additional one to show textual information, in form of key/value pairs, each of them associated with css classes for styling purpose
StyledOverlayBuilder	addNode(StyledNode parent, StyledNode node) Add a node as child of another one.
StyledOverlayBuilder	addRootNode(StyledNode item) Add a StyledNode as root
StyledOverlay	build(String cssRules) Builds the (immutable) StyledOverlay
StyledNode	createNode(String xpathLocator, String... classNames) Crate a StyledNode associated to the given CSS class names.
StyledRangeNode	createRangeNode(String locatorForTextNode, org.apache.commons.lang3.tuple.Pair<Integer,Integer> range, String... classNames)
StyledRangeNode	createRangeNode(String startTextNodeXPathLocator, String endTextNodeXPathLocator, org.apache.commons.lang3.tuple.Pair<Integer,Integer> range, String... classNames)
StyledOverlayBuilder.Rect	createRect(int top, int left, int width, int height)

Method Detail

createRect

StyledOverlayBuilder.Rect createRect(int top,
                                     int left,
                                     int width,
                                     int height)

build

StyledOverlay build(String cssRules)

Builds the (immutable) StyledOverlay

Parameters:

string -

Returns:

addRootNode

StyledOverlayBuilder addRootNode(StyledNode item)

Add a StyledNode as root

Parameters:

item - the root node to add

Returns:

the builder

Throws:

WebAPIRuntimeException - if the root node is already present

addNode

StyledOverlayBuilder addNode(StyledNode parent,
                             StyledNode node)

Add a node as child of another one. If the parent node is not already part of the tree, it is added as root.

Parameters:

parent - the parent node

node - the node to add

Returns:

the builder

addInfobox

void addInfobox(StyledNode referenceNode,
                org.apache.commons.lang3.tuple.Pair<String,String> keyValues,
                String... classNames)

Decorates this overlay with an additional one to show textual information, in form of key/value pairs, each of them associated with css classes for styling purpose

Parameters:

referenceNode -

keyValues -

classNames -

createNode

StyledNode createNode(String xpathLocator,
                      String... classNames)

Crate a StyledNode associated to the given CSS class names. This node refers a DOMNode addressed by xpath.

Parameters:

xpathLocator - the expression locating one DOMNode in the current page.

classNames - list of CSS class names for the created node

Returns:

a new StyledNode, not attached to the StyledOverlay being build

createRangeNode

StyledRangeNode createRangeNode(String startTextNodeXPathLocator,
                                String endTextNodeXPathLocator,
                                org.apache.commons.lang3.tuple.Pair<Integer,Integer> range,
                                String... classNames)

Parameters:

startTextNodeXPathLocator -

endTextNodeXPathLocator -

range -

classNames -

Returns:

createRangeNode

StyledRangeNode createRangeNode(String locatorForTextNode,
                                org.apache.commons.lang3.tuple.Pair<Integer,Integer> range,
                                String... classNames)

Parameters:

locatorForTextNode -

range -

classNames -

Returns:

addFixedHTMLBox

void addFixedHTMLBox(String innerHTML,
                     StyledOverlayBuilder.Rect boundingRect,
                     String... classNames)