com.azalient.api.b.display
Interface ILabel

All Superinterfaces:

IRecord, RecordR, RecordRW, RecordW, SortableData, StoreRecordRW

public interface ILabel
extends StoreRecordRW

A label is a text message displayed on the graphical window. It can be coloured, rotated, and can also be a hyperlink. The hyperlink functionality allows a number of options to be activated by double click:

• move the viewpoint to another view in the model
• open an external file (any format - PDF, DOC, XLS, etc) in its native application
• open any URL in the system-default web browser

Field Summary

Fields inherited from interface com.azalient.api.a.tables.IRecord

DELETED, KEY_SEP, KEY_SEP_CHAR

Method Summary

IAngle	angle() Returns the rotation angle for this label
NamedColour	colour() The display colour of the text message
double	height() The display height (in metres) of the text message
File	hyperlinkDocumentTarget() Returns any hyperlink viewpoint target.
IHyperlinkDrawableTarget	hyperlinkDrawableTarget() Returns any hyperlink viewpoint target.
URL	hyperlinkWebTarget() Returns any hyperlink viewpoint target.
boolean	magnify() Returns true if dynamic magnification is on for this label
IXyz	position() The position of the text message
String	text() The text message on the label

Methods inherited from interface com.azalient.api.file.StoreRecordRW

canRename, rename, store

Methods inherited from interface com.azalient.api.file.RecordR

extraSet, finished, isApplicable, isEditable, set

Methods inherited from interface com.azalient.api.a.tables.IRecord

name

Methods inherited from interface com.azalient.api.file.RecordW

extraCols, extraGet, extraGetB, extraGetD, extraGetI, extraGetS, extraGetT, get, isVolatile

Method Detail

text

String text()

The text message on the label

position

IXyz position()

The position of the text message

colour

NamedColour colour()

The display colour of the text message

height

double height()

The display height (in metres) of the text message

magnify

boolean magnify()

Returns true if dynamic magnification is on for this label

angle

IAngle angle()

Returns the rotation angle for this label

hyperlinkDrawableTarget

IHyperlinkDrawableTarget hyperlinkDrawableTarget()

Returns any hyperlink viewpoint target. This may return null, if none is defined.

hyperlinkDocumentTarget

File hyperlinkDocumentTarget()

Returns any hyperlink viewpoint target. This may return null, if none is defined.

hyperlinkWebTarget

URL hyperlinkWebTarget()

Returns any hyperlink viewpoint target. This may return null, if none is defined.