SimpleLabel (yFiles-for-JavaFX-Complete-3.0 API)

java.lang.Object
- com.yworks.yfiles.graph.SimpleLabel

All Implemented Interfaces:

ILabel, ILookup, IModelItem, ITagOwner
```
public class SimpleLabel
extends Object
implements ILabel
```
A simple mutable implementation of the ILabel interface that can be used stand-alone.
Note that this class is not the one used as the default implementation of a DefaultGraph's ILabels and casting them to SimpleLabel will fail. Instances of this class can be used without an accompanying graph instance. All of the properties are mutable. An example of a possible use case would be the rendering of a label into a graphics context: Simply create a SimpleLabel, associate a style with it and use the style's renderer instance to obtain a rendering for the label.

Field Summary
- Fields inherited from interface com.yworks.yfiles.graph.ILookup
  EMPTY

Constructor Summary

Constructors
Constructor and Description
`SimpleLabel(ILabelOwner owner, String text, ILabelModelParameter layoutParameter)` Creates an instance of the `SimpleLabel` class with default `lookup`, an instance of `VoidLabelStyle` and the given `parameter`, text, and owner.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`adoptPreferredSizeFromStyle()` Gets the `ILabelStyleRenderer.getPreferredSize(ILabel, ILabelStyle)` from the labels style and sets the `PreferredSize` to that value.
`ILabelModelParameter`	`getLayoutParameter()` Gets the label model's parameter that determines the positioning of this label.
`ILookup`	`getLookupImplementation()` Gets the `ILookup` implementation used for calls to `lookup(Class)` on this instance.
`ILabelOwner`	`getOwner()` Gets the owner of this label.
`SizeD`	`getPreferredSize()` Gets the preferred size of the label with respect to its current contents and the implementation of the visualization.
`ILabelStyle`	`getStyle()` Returns the style that is responsible for the visual representation of this node in a `CanvasControl`.
`Object`	`getTag()` Gets the tag associated with this instance.
`String`	`getText()` Gets the text string associated with this label.
`<TLookup> TLookup`	`lookup(Class<TLookup> type)` Returns an instance that implements the given type or `null`.
`void`	`setLayoutParameter(ILabelModelParameter value)` Sets the label model's parameter that determines the positioning of this label.
`void`	`setLookupImplementation(ILookup value)` Sets the `ILookup` implementation used for calls to `lookup(Class)` on this instance.
`void`	`setOwner(ILabelOwner value)` Sets the owner of this label.
`void`	`setPreferredSize(SizeD value)` Sets the preferred size of the label with respect to its current contents and the implementation of the visualization.
`void`	`setStyle(ILabelStyle value)` Returns the style that is responsible for the visual representation of this node in a `CanvasControl`.
`void`	`setTag(Object value)` Sets the tag associated with this instance.
`void`	`setText(String value)` Sets the text string associated with this label.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.yworks.yfiles.graph.ILabel
getIndex, getLayout

Methods inherited from interface com.yworks.yfiles.graph.ILookup
createDictionaryLookup, createDynamic, createSingle, createSingle, createWrapped, lookup, lookup, safeLookup

- Constructor Detail
  - SimpleLabel
```
public SimpleLabel(ILabelOwner owner,
                   String text,
                   ILabelModelParameter layoutParameter)
```
    Creates an instance of the SimpleLabel class with default lookup, an instance of VoidLabelStyle and the given parameter, text, and owner.
    
    Parameters:
    
    layoutParameter - The parameter that describes the label's layout.
    
    text - The label's text.
    
    owner - The label's owner.
- Method Detail
  - adoptPreferredSizeFromStyle
```
public void adoptPreferredSizeFromStyle()
```
    Gets the ILabelStyleRenderer.getPreferredSize(ILabel, ILabelStyle) from the labels style and sets the PreferredSize to that value.
  - getLayoutParameter
```
public final ILabelModelParameter getLayoutParameter()
```
    Description copied from interface: ILabel
    
    Gets the label model's parameter that determines the positioning of this label.
    In order to set a different parameter for this label, use IGraph's IGraph.setLabelLayoutParameter(ILabel, ILabelModelParameter) method. Note that the label model parameter instance associated with a label instance may be shared between multiple label instances and that the modification of this instance or its Model will result in a change of the positioning of all labels that are associated with the same parameter or model instance.
    
    Specified by:
    
    getLayoutParameter in interface ILabel
    
    Returns:
    
    The LayoutParameter.
  - getLookupImplementation
```
public final ILookup getLookupImplementation()
```
    Gets the ILookup implementation used for calls to lookup(Class) on this instance.
    
    Returns:
    
    The LookupImplementation.
    
    See Also:
    
    setLookupImplementation(ILookup)
  - getOwner
```
public final ILabelOwner getOwner()
```
    Description copied from interface: ILabel
    
    Gets the owner of this label.
    Typically this will yield an instance of INode or IEdge.
    
    Specified by:
    
    getOwner in interface ILabel
    
    Returns:
    
    The Owner.
  - getPreferredSize
```
public final SizeD getPreferredSize()
```
    Description copied from interface: ILabel
    
    Gets the preferred size of the label with respect to its current contents and the implementation of the visualization.
    Often times the layout's size will be the same as the preferred size, but it's up to the implementation of the ILabelModel to interpret it differently. In order to set a different preferred size for this label instance use IGraph's IGraph.setLabelPreferredSize(ILabel, SizeD) method.
    
    Specified by:
    
    getPreferredSize in interface ILabel
    
    Returns:
    
    The PreferredSize.
  - getStyle
```
public final ILabelStyle getStyle()
```
    Description copied from interface: ILabel
    
    Returns the style that is responsible for the visual representation of this node in a CanvasControl.
    In order to set the style on an instance, use the IGraph.setStyle(ILabel, ILabelStyle) method. Note that the style instance associated with a label instance may be shared between multiple label instances and that the modification of this style will result in a change of the appearance of all labels that are associated with the same style instance.
    
    Specified by:
    
    getStyle in interface ILabel
    
    Returns:
    
    The Style.
  - getTag
```
public final Object getTag()
```
    Description copied from interface: ITagOwner
    
    Gets the tag associated with this instance.
    The implementation itself does not normally depend on the tag associated with it. It serves as storage for the object only.
    
    Specified by:
    
    getTag in interface ITagOwner
    
    Returns:
    
    The user object associated with this instance.
    
    See Also:
    
    ITagOwner.setTag(Object)
  - getText
```
public final String getText()
```
    Description copied from interface: ILabel
    
    Gets the text string associated with this label.
    It is up to the visualization engine to interpret this property for the visualization of the label. Normally, it will render the text into the layout of this instance.
    
    Specified by:
    
    getText in interface ILabel
    
    Returns:
    
    The Text.
  - lookup
```
public <TLookup> TLookup lookup(Class<TLookup> type)
```
    Description copied from interface: ILookup
    
    Returns an instance that implements the given type or null. Typically, this method will be called in order to obtain a different view or aspect of the current instance. This is quite similar to casting or using a super type or interface of this instance, but is not limited to inheritance or compile time constraints. An instance implementing this method is not required to return non-null implementations for the types, nor does it have to return the same instance any time. Also it depends on the type and context whether the instance returned stays up to date or needs to be reobtained for subsequent use.
    
    Specified by:
    
    lookup in interface ILookup
    
    Parameters:
    
    type - the type for which an instance shall be returned
    
    Returns:
    
    an instance that is assignable to type or null
  - setLayoutParameter
```
public final void setLayoutParameter(ILabelModelParameter value)
```
    Sets the label model's parameter that determines the positioning of this label.
    In order to set a different parameter for this label, use IGraph's IGraph.setLabelLayoutParameter(ILabel, ILabelModelParameter) method. Note that the label model parameter instance associated with a label instance may be shared between multiple label instances and that the modification of this instance or its Model will result in a change of the positioning of all labels that are associated with the same parameter or model instance.
    
    Parameters:
    
    value - The LayoutParameter to set.
    
    See Also:
    
    getLayoutParameter()
  - setLookupImplementation
```
public final void setLookupImplementation(ILookup value)
```
    Sets the ILookup implementation used for calls to lookup(Class) on this instance.
    
    Parameters:
    
    value - The LookupImplementation to set.
    
    See Also:
    
    getLookupImplementation()
  - setOwner
```
public final void setOwner(ILabelOwner value)
```
    Sets the owner of this label.
    Typically this will yield an instance of INode or IEdge.
    
    Parameters:
    
    value - The Owner to set.
    
    See Also:
    
    getOwner()
  - setPreferredSize
```
public final void setPreferredSize(SizeD value)
```
    Sets the preferred size of the label with respect to its current contents and the implementation of the visualization.
    Often times the layout's size will be the same as the preferred size, but it's up to the implementation of the ILabelModel to interpret it differently. In order to set a different preferred size for this label instance use IGraph's IGraph.setLabelPreferredSize(ILabel, SizeD) method.
    
    Parameters:
    
    value - The PreferredSize to set.
    
    See Also:
    
    getPreferredSize()
  - setStyle
```
public final void setStyle(ILabelStyle value)
```
    Returns the style that is responsible for the visual representation of this node in a CanvasControl.
    In order to set the style on an instance, use the IGraph.setStyle(ILabel, ILabelStyle) method. Note that the style instance associated with a label instance may be shared between multiple label instances and that the modification of this style will result in a change of the appearance of all labels that are associated with the same style instance.
    
    Parameters:
    
    value - The Style to set.
    
    See Also:
    
    getStyle()
  - setTag
```
public final void setTag(Object value)
```
    Description copied from interface: ITagOwner
    
    Sets the tag associated with this instance.
    The implementation itself does not normally depend on the tag associated with it. It serves as storage for the object only.
    
    Specified by:
    
    setTag in interface ITagOwner
    
    Parameters:
    
    value - The user object associated with this instance.
    
    See Also:
    
    ITagOwner.getTag()
  - setText
```
public final void setText(String value)
```
    Sets the text string associated with this label.
    It is up to the visualization engine to interpret this property for the visualization of the label. Normally, it will render the text into the layout of this instance.
    
    Parameters:
    
    value - The Text to set.
    
    See Also:
    
    getText()

Class SimpleLabel

Field Summary

Fields inherited from interface com.yworks.yfiles.graph.ILookup

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.yworks.yfiles.graph.ILabel

Methods inherited from interface com.yworks.yfiles.graph.ILookup

Constructor Detail

SimpleLabel

Method Detail

adoptPreferredSizeFromStyle

getLayoutParameter

getLookupImplementation

getOwner

getPreferredSize

getStyle

getTag

getText

lookup

setLayoutParameter

setLookupImplementation

setOwner

setPreferredSize

setStyle

setTag

setText