ch.elexis.text.model
Class SSDRange

java.lang.Object
  ch.elexis.text.model.SSDRange

public class SSDRange
extends java.lang.Object

An SSDRange is some part of a SimpleStructuredDocument. It has a position and a length within the text Optionally, it can be placed outside the text flow. In that case, it must provide a viewport position relative to the character indicated by position. The contents of the Range is totally implementation specific. It might be some text or some graphics or both.

Author:

gerry

Field Summary

static java.lang.String	ATTR_VIEWPORT Some range types are displayed off the text flow.
static java.lang.String	ELEM_NAME
static java.lang.String	STYLE_BACKGROUND
static java.lang.String	STYLE_BOLD
static java.lang.String	STYLE_FOREGROUND
static java.lang.String	STYLE_ITALIC
static java.lang.String	STYLE_UNDERLINE
static java.lang.String	TYPE_MARKUP
static java.lang.String	TYPE_XREF

Constructor Summary

SSDRange(Element el)

SSDRange(int start, int len, java.lang.String typename, java.lang.String id)

Method Summary

java.lang.String	getContents()
java.lang.Object	getData() return user defined fata
java.lang.String	getHint()
java.lang.String	getID()
int	getLength()
int	getPosition()
java.lang.String	getType()
Rectangle	getViewPort()
boolean	isLocked()
void	setContents(java.lang.String c)
void	setData(java.lang.Object data) Link some user defined data to the object
void	setLength(int pos)
void	setPosition(int pos)
void	setViewPort(Rectangle r)
Element	toElement()

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_MARKUP

public static final java.lang.String TYPE_MARKUP

See Also:

Constant Field Values

TYPE_XREF

public static final java.lang.String TYPE_XREF

See Also:

Constant Field Values

ELEM_NAME

public static final java.lang.String ELEM_NAME

See Also:

Constant Field Values

ATTR_VIEWPORT

public static final java.lang.String ATTR_VIEWPORT

Some range types are displayed off the text flow. This is a hint in wich region of the screen to display

See Also:

Constant Field Values

STYLE_BOLD

public static final java.lang.String STYLE_BOLD

See Also:

Constant Field Values

STYLE_ITALIC

public static final java.lang.String STYLE_ITALIC

See Also:

Constant Field Values

STYLE_UNDERLINE

public static final java.lang.String STYLE_UNDERLINE

See Also:

Constant Field Values

STYLE_FOREGROUND

public static final java.lang.String STYLE_FOREGROUND

See Also:

Constant Field Values

STYLE_BACKGROUND

public static final java.lang.String STYLE_BACKGROUND

See Also:

Constant Field Values

Constructor Detail

SSDRange

public SSDRange(Element el)

SSDRange

public SSDRange(int start,
                int len,
                java.lang.String typename,
                java.lang.String id)

Method Detail

isLocked

public boolean isLocked()

getLength

public int getLength()

getPosition

public int getPosition()

getType

public java.lang.String getType()

getID

public java.lang.String getID()

setLength

public void setLength(int pos)

setPosition

public void setPosition(int pos)

getViewPort

public Rectangle getViewPort()

setViewPort

public void setViewPort(Rectangle r)

getHint

public java.lang.String getHint()

getContents

public java.lang.String getContents()

setContents

public void setContents(java.lang.String c)

toElement

public Element toElement()

setData

public void setData(java.lang.Object data)

Link some user defined data to the object

Parameters:

data -

getData

public java.lang.Object getData()

return user defined fata

Returns:

data as perviously set by setData()