Package org.eclipse.gef.fx.anchors
Class IComputationStrategy.Parameter<T>
- java.lang.Object
-
- javafx.beans.binding.ObjectExpression<T>
-
- javafx.beans.property.ReadOnlyObjectProperty<T>
-
- javafx.beans.property.ObjectProperty<T>
-
- javafx.beans.property.ObjectPropertyBase<T>
-
- org.eclipse.gef.fx.anchors.IComputationStrategy.Parameter<T>
-
- Type Parameters:
T
- The parameter value type.
- All Implemented Interfaces:
javafx.beans.Observable
,javafx.beans.property.Property<T>
,javafx.beans.property.ReadOnlyProperty<T>
,javafx.beans.value.ObservableObjectValue<T>
,javafx.beans.value.ObservableValue<T>
,javafx.beans.value.WritableObjectValue<T>
,javafx.beans.value.WritableValue<T>
- Direct Known Subclasses:
DynamicAnchor.AnchorageReferenceGeometry
,DynamicAnchor.AnchorageReferencePosition
,DynamicAnchor.AnchoredReferencePoint
,DynamicAnchor.PreferredOrientation
- Enclosing interface:
- IComputationStrategy
public abstract static class IComputationStrategy.Parameter<T> extends javafx.beans.property.ObjectPropertyBase<T>
Base class for all computation parameters that can be passed to anIComputationStrategy
.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
IComputationStrategy.Parameter.Kind
Indicates whether the parameter value can be shared to compute positions of all attached anchors or not.
-
Constructor Summary
Constructors Constructor Description Parameter(IComputationStrategy.Parameter.Kind kind)
Creates a new mandatoryIComputationStrategy.Parameter
of the given kind.Parameter(IComputationStrategy.Parameter.Kind kind, boolean optional)
Creates a new optional parameter of the given kind.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
bind(javafx.beans.value.ObservableValue<? extends T> newObservable)
protected static <T extends IComputationStrategy.Parameter<?>>
Tget(java.util.Collection<? extends IComputationStrategy.Parameter<?>> parameters, java.lang.Class<T> parameterType)
Retrieves a parameter of the respective type from the set of given parameters.java.lang.Object
getBean()
IComputationStrategy.Parameter.Kind
getKind()
Retrieves theIComputationStrategy.Parameter.Kind
of this parameter, which indicates whether a single value may be shared to compute the positions of all attachedAnchorKey
s or not.static IComputationStrategy.Parameter.Kind
getKind(java.lang.Class<? extends IComputationStrategy.Parameter<?>> paramType)
Returns theIComputationStrategy.Parameter.Kind
returned by an instance of the givenIComputationStrategy.Parameter
type.java.lang.String
getName()
void
invalidateBinding()
If this parameter is bound, can be used to invalidate the underlying binding, so that the value is re-computed.boolean
isOptional()
Indicates whether this parameter is optionalstatic boolean
isOptional(java.lang.Class<? extends IComputationStrategy.Parameter<?>> paramType)
Returnstrue
if an instance of the givenIComputationStrategy.Parameter
type is optional.void
unbind()
-
Methods inherited from class javafx.beans.property.ObjectPropertyBase
addListener, addListener, fireValueChangedEvent, get, invalidated, isBound, removeListener, removeListener, set, toString
-
Methods inherited from class javafx.beans.property.ObjectProperty
bindBidirectional, setValue, unbindBidirectional
-
Methods inherited from class javafx.beans.binding.ObjectExpression
asString, asString, asString, getValue, isEqualTo, isEqualTo, isNotEqualTo, isNotEqualTo, isNotNull, isNull, objectExpression
-
-
-
-
Constructor Detail
-
Parameter
public Parameter(IComputationStrategy.Parameter.Kind kind)
Creates a new mandatoryIComputationStrategy.Parameter
of the given kind.- Parameters:
kind
- The parameter kind.
-
Parameter
public Parameter(IComputationStrategy.Parameter.Kind kind, boolean optional)
Creates a new optional parameter of the given kind.- Parameters:
kind
- The parameter kin.optional
- Whether this parameter is optional or not.
-
-
Method Detail
-
get
protected static <T extends IComputationStrategy.Parameter<?>> T get(java.util.Collection<? extends IComputationStrategy.Parameter<?>> parameters, java.lang.Class<T> parameterType)
Retrieves a parameter of the respective type from the set of given parameters.- Type Parameters:
T
- The runtime type of the parameter.- Parameters:
parameters
- The set of parameters to search.parameterType
- The parameter type- Returns:
- The parameter or
null
.
-
getKind
public static IComputationStrategy.Parameter.Kind getKind(java.lang.Class<? extends IComputationStrategy.Parameter<?>> paramType)
Returns theIComputationStrategy.Parameter.Kind
returned by an instance of the givenIComputationStrategy.Parameter
type.- Parameters:
paramType
- TheIComputationStrategy.Parameter
type for which to return theIComputationStrategy.Parameter.Kind
.- Returns:
- The
IComputationStrategy.Parameter.Kind
for the givenIComputationStrategy.Parameter
type.
-
isOptional
public static boolean isOptional(java.lang.Class<? extends IComputationStrategy.Parameter<?>> paramType)
Returnstrue
if an instance of the givenIComputationStrategy.Parameter
type is optional. Otherwise returnsfalse
.- Parameters:
paramType
- TheIComputationStrategy.Parameter
type for which to determine optionality.- Returns:
true
if an instance of the givenIComputationStrategy.Parameter
type is optional, otherwisefalse
.
-
bind
public void bind(javafx.beans.value.ObservableValue<? extends T> newObservable)
-
getBean
public java.lang.Object getBean()
-
getKind
public final IComputationStrategy.Parameter.Kind getKind()
Retrieves theIComputationStrategy.Parameter.Kind
of this parameter, which indicates whether a single value may be shared to compute the positions of all attachedAnchorKey
s or not.- Returns:
- The parameter
IComputationStrategy.Parameter.Kind
.
-
getName
public java.lang.String getName()
-
invalidateBinding
public void invalidateBinding()
If this parameter is bound, can be used to invalidate the underlying binding, so that the value is re-computed.
-
isOptional
public final boolean isOptional()
Indicates whether this parameter is optional- Returns:
true
if the parameter is optional,false
otherwise.
-
-