This interface provides a mechanism for the Skin to support custom StyleAttributes. During the layout pass, the cell context is passed to the Skin so the latter can add inline style(s) to either the paragraph Node (typically TextFlow) or the text segment Node (Text).

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static enum	CellContext.RunDecor Specifies the decoration type to be applied to multiple text segments.

Method Summary

Modifier and Type	Method and Description
public void	addStyle(String the inline style string fxStyle) Adds an inline style.
public < the attribute type T> void	decorateRun(StyleAttribute<T> the attribute a, CellContext.RunDecor the decoration type type, String the style name styleName) Decorates the current segment with the specified attribute by coalescing adjacent runs into a single decoration pass.
public StyleAttributeMap	Returns: the current attributes. getAttributes() Returns the current attributes.
public Node	Returns: the node being styled. getNode() Returns the node being styled.

Method Detail

addStyle back to summary

addStyle	back to summary
public void addStyle(String fxStyle) Adds an inline style. The inline style must be a valid CSS style string, for example `"-fx-font-size:15px;"`. This string might contain multiple CSS properties. Parameters fxStyle:String the inline style string

public void addStyle(String fxStyle)

Adds an inline style.

The inline style must be a valid CSS style string, for example "-fx-font-size:15px;". This string might contain multiple CSS properties.

Parameters

fxStyle:String: the inline style string

decorateRun	back to summary
public <T> void decorateRun(StyleAttribute<T> a, CellContext.RunDecor type, String styleName) Decorates the current segment with the specified attribute by coalescing adjacent runs into a single decoration pass. This method is used when the visual representation requires uninterrupted segments instead of several adjacent ones, for example in the case of wavy underline, in order to avoid breaks in the wave. This method expects that for any attribute the corresponding type and styleName are the same. Parameters <T> the attribute type a:StyleAttribute<T> the attribute type:CellContext.RunDecor the decoration type styleName:String the style name Since 27

decorateRun

back to summary

public <T> void decorateRun(StyleAttribute<T> a, CellContext.RunDecor type, String styleName)

Decorates the current segment with the specified attribute by coalescing adjacent runs into a single decoration pass.

This method is used when the visual representation requires uninterrupted segments instead of several adjacent ones, for example in the case of wavy underline, in order to avoid breaks in the wave. This method expects that for any attribute the corresponding type and styleName are the same.

Parameters

<T>: the attribute type
a:StyleAttribute<T>: the attribute
type:CellContext.RunDecor: the decoration type
styleName:String: the style name

Since

getAttributes	back to summary
public StyleAttributeMap getAttributes() Returns the current attributes. Returns:StyleAttributeMap the current attributes.

getAttributes

back to summary

public StyleAttributeMap getAttributes()

Returns the current attributes.

Returns:StyleAttributeMap: the current attributes.

getNode	back to summary
public Node getNode() Returns the node being styled. This might be a TextFlow (for the paragraph cell context) or Text (for the text segment cell context). Returns:Node the node being styled.

getNode

back to summary

public Node getNode()

Returns the node being styled.

This might be a TextFlow (for the paragraph cell context) or Text (for the text segment cell context).

Returns:Node: the node being styled.

jfx.incubator.scene.control.richtext.skin back to summary

public final Enum CellContext.RunDecor

Class Inheritance

extends Enum<CellContext.RunDecor>

java.lang.Object
java.lang.Enum
jfx.incubator.scene.control.richtext.skin.CellContext.RunDecor

Specifies the decoration type to be applied to multiple text segments.

Since: 27

Field Summary

Modifier and Type	Field and Description
public static final CellContext.RunDecor	HIGHLIGHT Text background (highlight) decoration.
public static final CellContext.RunDecor	WAVY_UNDERLINE Wavy underline decoration.

Constructor Summary

Access	Constructor and Description
private	RunDecor()

Method Summary

Modifier and Type	Method and Description
public static CellContext.RunDecor	valueOf(String name)
public static CellContext.RunDecor[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

HIGHLIGHT	back to summary
public static final CellContext.RunDecor HIGHLIGHT Text background (highlight) decoration.

WAVY_UNDERLINE	back to summary
public static final CellContext.RunDecor WAVY_UNDERLINE Wavy underline decoration.

Constructor Detail

RunDecor	back to summary
private RunDecor()

Method Detail

valueOf	back to summary
public static CellContext.RunDecor valueOf(String name)

values	back to summary
public static CellContext.RunDecor[] values()

public Interface CellContext

Nested and Inner Type Summary

Method Summary

Method Detail

public final Enum CellContext.RunDecor

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail