Module omix.api

Package omix.plugin.diagram.writable

Interface Legend

All Superinterfaces:

AbstractItem, AbstractItem, Groupable, Groupable, Legend, ReadOnlyInterface, WritableInterface

public interface Legend
extends AbstractItem, Legend, Groupable

Method Summary

Modifier and Type	Method	Description
void	setBrush(Brush brush)	Sets the fill brush of the item's shape.
void	setFont(Font font)	Changes the font of the text label of the item.
void	setHeadline(String text)
void	setHidden(boolean hidden)	Changes the visibility of the item in the diagram.
void	setIdentifier(String identifier)	Changes identifier of the item.
void	setPosition(double x, double y)	Set the position of the item.
void	setSize(double width, double height)	Changes the item's size.
void	setStrokeColor(Color strokeColor)	Sets the color for the stroke of the item's shape.
void	setStrokeStyle(StrokeStyle strokeStyle)	Changes the paint style for the stroke of the item's shape.
void	setStrokeWidth(double strokeWidth)	Changes the stroke width of the item's shape.
void	setTransparency(double transparency)	Changes the transparency of the item's shape.
void	setZValue(double z)	Change z layer of the item (defines the stacked position of the item in the diagram).
Legend	toReadOnly()

Methods inherited from interface omix.plugin.diagram.AbstractItem

addChangeListener, addPropertyChangeListener, getIdentifier, removeChangeListener, removePropertyChangeListener

Methods inherited from interface omix.plugin.diagram.writable.AbstractItem

diagram, isChangeable

Methods inherited from interface omix.plugin.diagram.writable.Groupable

group

Methods inherited from interface omix.plugin.diagram.Legend

blur, brush, headline, headlineFont, height, hidden, scale, strokeColor, strokeStyle, strokeWidth, transparency, width, x, y, zValue

Method Details

setIdentifier

void setIdentifier(String identifier) throws ComponentExistsException, IllegalChangeException

Changes identifier of the item.

Parameters:

identifier - the new name of the item. CAUTION, the name must be unique in the network.

Throws:

ComponentExistsException

IllegalChangeException

setPosition

void setPosition(double x, double y) throws IllegalChangeException

Set the position of the item.

Parameters:

x -

y -

Throws:

IllegalChangeException

setSize

void setSize(double width, double height) throws IllegalChangeException

Changes the item's size.

Parameters:

width -

height -

Throws:

IllegalChangeException

setHidden

void setHidden(boolean hidden) throws IllegalChangeException

Changes the visibility of the item in the diagram.

Parameters:

hidden -

Throws:

IllegalChangeException

setBrush

void setBrush(@NonNull Brush brush) throws IllegalChangeException

Sets the fill brush of the item's shape.

Parameters:

brush - the new paint brush

Throws:

IllegalChangeException

See Also:

Legend.brush()

setFont

void setFont(@NonNull Font font) throws IllegalChangeException

Changes the font of the text label of the item.

Parameters:

font -

Throws:

IllegalChangeException

See Also:

Legend.headlineFont()

setStrokeWidth

void setStrokeWidth(double strokeWidth) throws IllegalChangeException

Changes the stroke width of the item's shape.

Parameters:

strokeWidth -

Throws:

IllegalChangeException

See Also:

Legend.strokeWidth()

setStrokeStyle

void setStrokeStyle(@NonNull StrokeStyle strokeStyle) throws IllegalChangeException

Changes the paint style for the stroke of the item's shape.

Parameters:

strokeStyle -

Throws:

IllegalChangeException

See Also:

Legend.strokeStyle()

setStrokeColor

void setStrokeColor(@NonNull Color strokeColor) throws IllegalChangeException

Sets the color for the stroke of the item's shape.

Parameters:

strokeColor -

Throws:

IllegalChangeException

See Also:

Legend.strokeColor()

setTransparency

void setTransparency(double transparency) throws IllegalChangeException

Changes the transparency of the item's shape.

Parameters:

transparency -

Throws:

IllegalChangeException

setZValue

void setZValue(double z) throws IllegalChangeException

Change z layer of the item (defines the stacked position of the item in the diagram).

Parameters:

z -

Throws:

IllegalChangeException

setHeadline

void setHeadline(String text) throws IllegalChangeException

Throws:

IllegalChangeException

toReadOnly

Legend toReadOnly()

Specified by:

toReadOnly in interface AbstractItem

Specified by:

toReadOnly in interface Groupable

Specified by:

toReadOnly in interface WritableInterface