org.hkijena.jipipe.extensions.parameters.library.roi

Class FixedMargin

java.lang.Object

org.hkijena.jipipe.extensions.parameters.library.roi.FixedMargin

All Implemented Interfaces:

JIPipeParameterCollection

public class FixedMargin
extends Object
implements JIPipeParameterCollection

Related to Margin, but with fixed-size objects

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FixedMargin.List List parameter of FixedMargin

Nested classes/interfaces inherited from interface org.hkijena.jipipe.api.parameters.JIPipeParameterCollection

JIPipeParameterCollection.ParameterChangedEvent, JIPipeParameterCollection.ParameterStructureChangedEvent, JIPipeParameterCollection.ParameterUIChangedEvent

Field Summary

Fields

Modifier and Type	Field and Description
static int	PARAM_BOTTOM
static int	PARAM_HEIGHT
static int	PARAM_LEFT
static int	PARAM_RIGHT
static int	PARAM_TOP
static int	PARAM_WIDTH

Constructor Summary

Constructors

Constructor and Description
FixedMargin() Creates a new instance
FixedMargin(Anchor anchor)
FixedMargin(FixedMargin other) Creates a copy
FixedMargin(Rectangle rectangle) Creates a margin from a rectangle

Method Summary

Modifier and Type	Method and Description
Anchor	getAnchor()
NumericFunctionExpression	getBottom()
EventBus	getEventBus() Gets the event bus that posts events about the parameters
NumericFunctionExpression	getLeft()
Set<String>	getRelevantParameterKeys() Finds the parameter keys that are relevant according to the current anchor setting The anchor key 'anchor' is not part of the result.
NumericFunctionExpression	getRight()
NumericFunctionExpression	getTop()
Rectangle	place(Rectangle object, Rectangle availableArea, ExpressionVariables parameters) Generates the rectangle defined by the definition.
void	setAnchor(Anchor anchor)
void	setBottom(NumericFunctionExpression bottom)
void	setLeft(NumericFunctionExpression left)
void	setRight(NumericFunctionExpression right)
void	setTop(NumericFunctionExpression top)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hkijena.jipipe.api.parameters.JIPipeParameterCollection

addParameterChangeListener, addParameterChangeListener, getContextActions, getParameter, getParameterAccess, isParameterUIVisible, isParameterUIVisible, setParameter, triggerParameterChange, triggerParameterStructureChange, triggerParameterUIChange

Field Detail

PARAM_LEFT

public static final int PARAM_LEFT

See Also:

Constant Field Values

PARAM_TOP

public static final int PARAM_TOP

See Also:

Constant Field Values

PARAM_RIGHT

public static final int PARAM_RIGHT

See Also:

Constant Field Values

PARAM_BOTTOM

public static final int PARAM_BOTTOM

See Also:

Constant Field Values

PARAM_WIDTH

public static final int PARAM_WIDTH

See Also:

Constant Field Values

PARAM_HEIGHT

public static final int PARAM_HEIGHT

See Also:

Constant Field Values

Constructor Detail

FixedMargin

public FixedMargin()

Creates a new instance

FixedMargin

public FixedMargin(Rectangle rectangle)

Creates a margin from a rectangle

Parameters:

rectangle - the rectangle

FixedMargin

public FixedMargin(FixedMargin other)

Creates a copy

Parameters:

other - the original

FixedMargin

public FixedMargin(Anchor anchor)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getLeft

public NumericFunctionExpression getLeft()

setLeft

public void setLeft(NumericFunctionExpression left)

getTop

public NumericFunctionExpression getTop()

setTop

public void setTop(NumericFunctionExpression top)

getRight

public NumericFunctionExpression getRight()

setRight

public void setRight(NumericFunctionExpression right)

getBottom

public NumericFunctionExpression getBottom()

setBottom

public void setBottom(NumericFunctionExpression bottom)

getAnchor

public Anchor getAnchor()

setAnchor

public void setAnchor(Anchor anchor)

place

public Rectangle place(Rectangle object,
                       Rectangle availableArea,
                       ExpressionVariables parameters)

Generates the rectangle defined by the definition. If the rectangle is invalid, null is returned

Parameters:

object - the object to be placed

availableArea - rectangle describing the available area.

parameters - additional expression variables

Returns:

Rectangle within the area

getRelevantParameterKeys

public Set<String> getRelevantParameterKeys()

Finds the parameter keys that are relevant according to the current anchor setting The anchor key 'anchor' is not part of the result.

Returns:

the keys

getEventBus

public EventBus getEventBus()

Description copied from interface: JIPipeParameterCollection

Gets the event bus that posts events about the parameters

Specified by:

getEventBus in interface JIPipeParameterCollection

Returns:

The event bus triggering JIPipeParameterCollection.ParameterChangedEvent and JIPipeParameterCollection.ParameterStructureChangedEvent