org.eclipse.gef4.zest.fx.parts

Class NodeContentPart

java.lang.Object

org.eclipse.gef4.mvc.parts.AbstractVisualPart<VR,V>

org.eclipse.gef4.mvc.parts.AbstractContentPart<javafx.scene.Node,V>

org.eclipse.gef4.mvc.fx.parts.AbstractFXContentPart<javafx.scene.Group>

org.eclipse.gef4.zest.fx.parts.NodeContentPart

All Implemented Interfaces:

IActivatable, IAdaptable, IDisposable, IPropertyChangeNotifier, IContentPart<javafx.scene.Node,javafx.scene.Group>, IVisualPart<javafx.scene.Node,javafx.scene.Group>

public class NodeContentPart
extends AbstractFXContentPart<javafx.scene.Group>

The NodeContentPart is the controller for a Node content object.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NodeContentPart.NestedGraphIcon JavaFX Node displaying a small icon representing a nested graph.

Nested classes/interfaces inherited from interface org.eclipse.gef4.common.adapt.IAdaptable

IAdaptable.Bound<A extends IAdaptable>

Field Summary

Fields

Modifier and Type	Field and Description
protected static double	CHILDREN_PANE_HEIGHT_THRESHOLD The minimum height for the nested graph area.
protected static double	CHILDREN_PANE_WIDTH_THRESHOLD The minimum width for the nested graph area.
static java.lang.String	CSS_CLASS The CSS class that is applied to the visual of this NodeContentPart.
static java.lang.String	CSS_CLASS_ICON The CSS class that is applied to the Image that displays the icon.
static java.lang.String	CSS_CLASS_LABEL The CSS class that is applied to the Text that displays the label.
static java.lang.String	CSS_CLASS_SHAPE The CSS class that is applied to the Rectangle that displays border and background.
protected static double	DEFAULT_CHILDREN_PANE_HEIGHT The default height of the nested graph area.
protected static double	DEFAULT_CHILDREN_PANE_WIDTH The default width of the nested graph area.
static double	DEFAULT_NESTED_CHILDREN_ZOOM_FACTOR The default zoom factor that is applied to the nested graph area.
protected static double	DEFAULT_PADDING The default padding between the node's border and its content.
protected static double	ZOOMLEVEL_SHOW_NESTED_GRAPH The zoom level that needs to be reached for the getContentChildren() method to return a nested Graph.

Fields inherited from class org.eclipse.gef4.mvc.parts.AbstractVisualPart

pcs

Fields inherited from interface org.eclipse.gef4.mvc.parts.IContentPart

CONTENT_PROPERTY

Fields inherited from interface org.eclipse.gef4.mvc.parts.IVisualPart

ANCHORAGES_PROPERTY, ANCHOREDS_PROPERTY, CHILDREN_PROPERTY, PARENT_PROPERTY

Fields inherited from interface org.eclipse.gef4.common.adapt.IAdaptable

ADAPTERS_PROPERTY

Fields inherited from interface org.eclipse.gef4.common.activate.IActivatable

ACTIVE_PROPERTY

Constructor Summary

Constructors

Constructor and Description
NodeContentPart()

Method Summary

Modifier and Type	Method and Description
protected void	addChildVisual(IVisualPart<javafx.scene.Node,? extends javafx.scene.Node> child, int index)
protected javafx.scene.layout.Pane	createNestedContentPane() Creates the Pane that is used to display nested content.
protected javafx.scene.layout.StackPane	createNestedContentStackPane(javafx.scene.layout.Pane nestedContentPane) Creates the StackPane that is used to either display nested content, or an icon indicating that nested content exists for this NodeContentPart.
protected void	createNodeVisual(javafx.scene.Group group, javafx.scene.shape.Rectangle rect, javafx.scene.image.ImageView iconImageView, javafx.scene.text.Text labelText, javafx.scene.layout.StackPane nestedContentStackPane) Creates the node visual.
protected javafx.scene.Group	createVisual()
protected void	doActivate()
protected void	doDeactivate()
void	doRefreshVisual(javafx.scene.Group visual)
Node	getContent()
java.util.List<? extends java.lang.Object>	getContentChildren()
protected javafx.scene.image.ImageView	getIconImageView() Returns the ImageView that displays the node's icon.
protected javafx.scene.text.Text	getLabelText() Returns the Text that displays the node's label.
javafx.scene.layout.Pane	getNestedChildrenPane() Returns the Pane to which nested children are added.
protected javafx.scene.layout.StackPane	getNestedContentStackPane() Returns the StackPane that either displays nested content or an icon indicating that nested content exists for this NodeContentPart.
protected javafx.scene.Node	getNestedGraphIcon() Returns the Node that is displayed in the getNestedContentStackPane() when nested content is available, but not rendered, currently.
protected javafx.scene.shape.Rectangle	getNodeRect() Returns the Rectangle that displays the node's border and background.
protected double	getPadding() Returns the padding that is maintained between the node's border and its content.
protected void	hideNestedGraphIcon() Removes the getNestedGraphIcon() from the getNestedContentStackPane() and sets the nested graph icon to null.
protected boolean	isNesting() Returns true if this NodeContentPart contains a nested Graph.
protected void	refreshCssClass(javafx.scene.Group visual, java.lang.String cssClass) Adds the given CSS class to the given visual.
protected java.lang.String	refreshFisheye(javafx.scene.Group visual, java.util.Map<java.lang.String,java.lang.Object> attrs, java.lang.String str) Adjusts the visualization to reflect the fisheye state of the node.
protected void	refreshIcon(javafx.scene.Group visual, java.lang.Object icon) If the given icon is an Image, that Image will be used as the icon of this NodeContentPart.
protected void	refreshLabel(javafx.scene.Group visual, java.lang.String str) Changes the label of this NodeContentPart to the given value.
protected void	refreshNestedGraphArea(javafx.scene.Group visual, boolean isNesting) When this node has a nested graph, space is reserved for it, so that the transition from an icon to the real graph will not change the node's size.
protected void	refreshTooltip(javafx.scene.Group visual, java.lang.Object tooltip) Changes the tooltip of this NodeContentPart to the given value.
protected void	removeChildVisual(IVisualPart<javafx.scene.Node,? extends javafx.scene.Node> child, int index)
protected void	resizeNestedGraphArea(double dw, double dh) Resizes the area for the graph nested in this node.
protected void	setNestedGraphIcon(javafx.scene.Node nestedGraphIcon) Changes the nested graph icon that is displayed to indicate that nested content is available to the given value.
protected void	showNestedGraphIcon() Creates the nested graph icon and adds it to the getNestedContentStackPane().

Methods inherited from class org.eclipse.gef4.mvc.fx.parts.AbstractFXContentPart

registerAtVisualPartMap, registerNestedVisuals, unregisterFromVisualPartMap, unregisterNestedVisuals

Methods inherited from class org.eclipse.gef4.mvc.parts.AbstractContentPart

addContentChild, attachToContentAnchorage, detachFromContentAnchorage, getContentAnchorages, register, registerAtContentPartMap, removeContentChild, setContent, unregister, unregisterFromContentPartMap

Methods inherited from class org.eclipse.gef4.mvc.parts.AbstractVisualPart

activate, addAnchorage, addAnchorage, addAnchored, addChild, addChild, addChildren, addChildren, addPropertyChangeListener, attachToAnchorageVisual, deactivate, detachFromAnchorageVisual, dispose, getAdapter, getAdapter, getAdapter, getAdapters, getAdapters, getAnchorages, getAnchoreds, getBehaviors, getChildren, getParent, getPolicies, getRoot, getViewer, getVisual, isActive, isRefreshVisual, refreshVisual, removeAnchorage, removeAnchorage, removeAnchored, removeChild, removeChildren, removePropertyChangeListener, reorderChild, setAdapter, setAdapter, setAdapter, setAdapters, setParent, setRefreshVisual, unsetAdapter

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.gef4.mvc.parts.IVisualPart

addAnchorage, addAnchorage, addAnchored, addChild, addChild, addChildren, addChildren, getAnchorages, getAnchoreds, getBehaviors, getChildren, getParent, getPolicies, getRoot, getVisual, isRefreshVisual, refreshVisual, removeAnchorage, removeAnchorage, removeAnchored, removeChild, removeChildren, reorderChild, setParent, setRefreshVisual

Methods inherited from interface org.eclipse.gef4.common.adapt.IAdaptable

getAdapter, getAdapter, getAdapter, getAdapters, getAdapters, setAdapter, setAdapter, setAdapter, unsetAdapter

Methods inherited from interface org.eclipse.gef4.common.activate.IActivatable

activate, deactivate, isActive

Methods inherited from interface org.eclipse.gef4.common.properties.IPropertyChangeNotifier

addPropertyChangeListener, removePropertyChangeListener

Methods inherited from interface org.eclipse.gef4.common.dispose.IDisposable

dispose

Field Detail

DEFAULT_PADDING

protected static final double DEFAULT_PADDING

The default padding between the node's border and its content.

See Also:

Constant Field Values

ZOOMLEVEL_SHOW_NESTED_GRAPH

protected static final double ZOOMLEVEL_SHOW_NESTED_GRAPH

The zoom level that needs to be reached for the getContentChildren() method to return a nested Graph.

See Also:

Constant Field Values

DEFAULT_CHILDREN_PANE_WIDTH

protected static final double DEFAULT_CHILDREN_PANE_WIDTH

The default width of the nested graph area.

See Also:

Constant Field Values

DEFAULT_CHILDREN_PANE_HEIGHT

protected static final double DEFAULT_CHILDREN_PANE_HEIGHT

The default height of the nested graph area.

See Also:

Constant Field Values

CHILDREN_PANE_WIDTH_THRESHOLD

protected static final double CHILDREN_PANE_WIDTH_THRESHOLD

The minimum width for the nested graph area.

See Also:

Constant Field Values

CHILDREN_PANE_HEIGHT_THRESHOLD

protected static final double CHILDREN_PANE_HEIGHT_THRESHOLD

The minimum height for the nested graph area.

See Also:

Constant Field Values

DEFAULT_NESTED_CHILDREN_ZOOM_FACTOR

public static final double DEFAULT_NESTED_CHILDREN_ZOOM_FACTOR

The default zoom factor that is applied to the nested graph area.

See Also:

Constant Field Values

CSS_CLASS

public static final java.lang.String CSS_CLASS

The CSS class that is applied to the visual of this NodeContentPart.

See Also:

Constant Field Values

CSS_CLASS_SHAPE

public static final java.lang.String CSS_CLASS_SHAPE

The CSS class that is applied to the Rectangle that displays border and background.

See Also:

Constant Field Values

CSS_CLASS_LABEL

public static final java.lang.String CSS_CLASS_LABEL

The CSS class that is applied to the Text that displays the label.

See Also:

Constant Field Values

CSS_CLASS_ICON

public static final java.lang.String CSS_CLASS_ICON

The CSS class that is applied to the Image that displays the icon.

See Also:

Constant Field Values

Constructor Detail

NodeContentPart

public NodeContentPart()

Method Detail

addChildVisual

protected void addChildVisual(IVisualPart<javafx.scene.Node,? extends javafx.scene.Node> child,
                              int index)

Overrides:

addChildVisual in class AbstractVisualPart<javafx.scene.Node,javafx.scene.Group>

createNestedContentPane

protected javafx.scene.layout.Pane createNestedContentPane()

Creates the Pane that is used to display nested content.

Returns:

The Pane that is used to display nested content.

createNestedContentStackPane

protected javafx.scene.layout.StackPane createNestedContentStackPane(javafx.scene.layout.Pane nestedContentPane)

Creates the StackPane that is used to either display nested content, or an icon indicating that nested content exists for this NodeContentPart. The given Pane is inserted into the children list of the created StackPane.

Parameters:

nestedContentPane - The nested content Pane.

Returns:

The created StackPane.

createNodeVisual

protected void createNodeVisual(javafx.scene.Group group,
                                javafx.scene.shape.Rectangle rect,
                                javafx.scene.image.ImageView iconImageView,
                                javafx.scene.text.Text labelText,
                                javafx.scene.layout.StackPane nestedContentStackPane)

Creates the node visual. The given ImageView, Text, and StackPane are inserted into that node visual to display the node's icon, label and nested children, respectively. The node visual needs to be inserted into the given Group.

Parameters:

group - This node's visual.

rect - The Rectangle displaying border and background.

iconImageView - The ImageView displaying the node's icon.

labelText - The Text displaying the node's label.

nestedContentStackPane - The StackPane displaying the node's nested content.

createVisual

protected javafx.scene.Group createVisual()

Specified by:

createVisual in class AbstractVisualPart<javafx.scene.Node,javafx.scene.Group>

doActivate

protected void doActivate()

Overrides:

doActivate in class AbstractVisualPart<javafx.scene.Node,javafx.scene.Group>

doDeactivate

protected void doDeactivate()

Overrides:

doDeactivate in class AbstractVisualPart<javafx.scene.Node,javafx.scene.Group>

doRefreshVisual

public void doRefreshVisual(javafx.scene.Group visual)

Specified by:

doRefreshVisual in class AbstractVisualPart<javafx.scene.Node,javafx.scene.Group>

getContent

public Node getContent()

Specified by:

getContent in interface IContentPart<javafx.scene.Node,javafx.scene.Group>

Overrides:

getContent in class AbstractContentPart<javafx.scene.Node,javafx.scene.Group>

getContentChildren

public java.util.List<? extends java.lang.Object> getContentChildren()

Specified by:

getContentChildren in interface IContentPart<javafx.scene.Node,javafx.scene.Group>

Overrides:

getContentChildren in class AbstractContentPart<javafx.scene.Node,javafx.scene.Group>

getIconImageView

protected javafx.scene.image.ImageView getIconImageView()

Returns the ImageView that displays the node's icon.

Returns:

The ImageView that displays the node's icon.

getLabelText

protected javafx.scene.text.Text getLabelText()

Returns the Text that displays the node's label.

Returns:

The Text that displays the node's label.

getNestedChildrenPane

public javafx.scene.layout.Pane getNestedChildrenPane()

Returns the Pane to which nested children are added.

Returns:

The Pane to which nested children are added.

getNestedContentStackPane

protected javafx.scene.layout.StackPane getNestedContentStackPane()

Returns the StackPane that either displays nested content or an icon indicating that nested content exists for this NodeContentPart.

Returns:

The StackPane that wraps nested content.

getNestedGraphIcon

protected javafx.scene.Node getNestedGraphIcon()

Returns the Node that is displayed in the getNestedContentStackPane() when nested content is available, but not rendered, currently.

Returns:

The Node that is displayed in the getNestedContentStackPane() when nested content is available, but not rendered, currently.

getNodeRect

protected javafx.scene.shape.Rectangle getNodeRect()

Returns the Rectangle that displays the node's border and background.

Returns:

The Rectangle that displays the node's border and background.

getPadding

protected double getPadding()

Returns the padding that is maintained between the node's border and its content.

Returns:

The padding that is maintained between the node's border and its content.

hideNestedGraphIcon

protected void hideNestedGraphIcon()

Removes the getNestedGraphIcon() from the getNestedContentStackPane() and sets the nested graph icon to null.

isNesting

protected boolean isNesting()

Returns true if this NodeContentPart contains a nested Graph. Otherwise, false is returned.

Returns:

true if this NodeContentPart contains a nested Graph, otherwise false.

refreshCssClass

protected void refreshCssClass(javafx.scene.Group visual,
                               java.lang.String cssClass)

Adds the given CSS class to the given visual.

Parameters:

visual - The visual to which the CSS class is added.

cssClass - The CSS class that is added to the visual.

refreshFisheye

protected java.lang.String refreshFisheye(javafx.scene.Group visual,
                                          java.util.Map<java.lang.String,java.lang.Object> attrs,
                                          java.lang.String str)

Adjusts the visualization to reflect the fisheye state of the node. If the node is in fisheye state, its label will be reduced to the first letter.

Parameters:

visual - The visual of this NodeContentPart.

attrs - The attributes map that stores the fisheye state of this NodeContentPart.

str - The label of this NodeContentPart.

Returns:

The adjusted label for this NodeContentPart.

refreshIcon

protected void refreshIcon(javafx.scene.Group visual,
                           java.lang.Object icon)

If the given icon is an Image, that Image will be used as the icon of this NodeContentPart.

Parameters:

visual - The visual of this NodeContentPart.

icon - The new icon for this NodeContentPart.

refreshLabel

protected void refreshLabel(javafx.scene.Group visual,
                            java.lang.String str)

Changes the label of this NodeContentPart to the given value.

Parameters:

visual - The visual of this NodeContentPart.

str - The new label for this NodeContentPart.

refreshNestedGraphArea

protected void refreshNestedGraphArea(javafx.scene.Group visual,
                                      boolean isNesting)

When this node has a nested graph, space is reserved for it, so that the transition from an icon to the real graph will not change the node's size.

Parameters:

visual - The visual of this part.

isNesting - true if this node has a nested graph, otherwise false.

refreshTooltip

protected void refreshTooltip(javafx.scene.Group visual,
                              java.lang.Object tooltip)

Changes the tooltip of this NodeContentPart to the given value.

Parameters:

visual - The visual of this NodeContentPart.

tooltip - The new tooltip for this NodeContentPart.

removeChildVisual

protected void removeChildVisual(IVisualPart<javafx.scene.Node,? extends javafx.scene.Node> child,
                                 int index)

Overrides:

removeChildVisual in class AbstractVisualPart<javafx.scene.Node,javafx.scene.Group>

resizeNestedGraphArea

protected void resizeNestedGraphArea(double dw,
                                     double dh)

Resizes the area for the graph nested in this node.

Parameters:

dw - Delta width.

dh - Delta height.

setNestedGraphIcon

protected void setNestedGraphIcon(javafx.scene.Node nestedGraphIcon)

Changes the nested graph icon that is displayed to indicate that nested content is available to the given value.

Parameters:

nestedGraphIcon - The new nested graph icon.

showNestedGraphIcon

protected void showNestedGraphIcon()

Creates the nested graph icon and adds it to the getNestedContentStackPane().