com.yworks.yfiles.graph

Interface IPortDefaults

All Known Implementing Classes:

PortDefaults

public interface IPortDefaults

Interface used by IGraph to declare and obtain the defaults for ports at nodes and edges.

Note that changing these defaults does not change properties of already created model items. Rather, only items created after the change are affected.

See Also:

IPort, INodeDefaults.getPortDefaults(), IEdgeDefaults.getPortDefaults(), IGraph.getNodeDefaults(), IGraph.getEdgeDefaults()

Method Summary

Modifier and Type	Method and Description
IPortLocationModelParameter	getLocationParameter() Gets the location model parameter to use for ports.
IPortLocationModelParameter	getLocationParameterInstance(IPortOwner owner) Factory method that returns a location model parameter instance for use with newly created ports.
IPortStyle	getStyle() Gets the style to use for ports.
IPortStyle	getStyleInstance(IPortOwner owner) Factory method that returns a style instance for use with newly created ports.
boolean	isAutoCleanupEnabled() Determines whether unused ports should automatically be removed from their owners as soon as no further edge is connected to them.
boolean	isLocationParameterInstanceSharingEnabled() Gets a value indicating whether the LocationParameter instance should be shared referentially or cloned upon a call to getLocationParameterInstance(IPortOwner).
boolean	isStyleInstanceSharingEnabled() Gets a value indicating whether the Style instance should be shared referentially or cloned upon a call to getStyleInstance(IPortOwner).
void	setAutoCleanupEnabled(boolean value) Determines whether unused ports should automatically be removed from their owners as soon as no further edge is connected to them.
void	setLocationParameter(IPortLocationModelParameter value) Sets the location model parameter to use for ports.
void	setLocationParameterInstanceSharingEnabled(boolean value) Sets a value indicating whether the LocationParameter instance should be shared referentially or cloned upon a call to getLocationParameterInstance(IPortOwner).
void	setStyle(IPortStyle value) Sets the style to use for ports.
void	setStyleInstanceSharingEnabled(boolean value) Sets a value indicating whether the Style instance should be shared referentially or cloned upon a call to getStyleInstance(IPortOwner).

Method Detail

getLocationParameter

IPortLocationModelParameter getLocationParameter()

Gets the location model parameter to use for ports.

Depending on the setting of LocationParameterInstanceSharingEnabled, the getLocationParameterInstance(IPortOwner) method should return a clone of this instance or the very same instance.

Returns:

The parameter to use as a template.

See Also:

isLocationParameterInstanceSharingEnabled(), getLocationParameterInstance(IPortOwner), setLocationParameter(IPortLocationModelParameter)

getLocationParameterInstance

IPortLocationModelParameter getLocationParameterInstance(IPortOwner owner)

Factory method that returns a location model parameter instance for use with newly created ports.

Most implementations will yield either, a clone of or the LocationParameter property, if LocationParameterInstanceSharingEnabled is enabled, but they might use more complicated logic, too.

Parameters:

owner - The owner of the port that will be created.

Returns:

The parameter to use, which for most implementations is either a clone of or the LocationParameter property, if LocationParameterInstanceSharingEnabled is enabled.

getStyle

IPortStyle getStyle()

Gets the style to use for ports.

Depending on the setting of StyleInstanceSharingEnabled, the getStyleInstance(IPortOwner) method should return a clone of this instance or the very same instance.

Returns:

The style to use as a template.

See Also:

isStyleInstanceSharingEnabled(), setStyle(IPortStyle)

getStyleInstance

IPortStyle getStyleInstance(IPortOwner owner)

Factory method that returns a style instance for use with newly created ports.

Most implementations will yield either, a clone of or the Style property, if StyleInstanceSharingEnabled is enabled, but they might use more complicated logic, too.

Parameters:

owner - The owner of the port that will be created.

Returns:

The style to use, which for most implementations is either a clone of or the Style property, if StyleInstanceSharingEnabled is enabled.

isAutoCleanupEnabled

boolean isAutoCleanupEnabled()

Determines whether unused ports should automatically be removed from their owners as soon as no further edge is connected to them.

Returns:

The AutoCleanupEnabled.

See Also:

IGraph.remove(com.yworks.yfiles.graph.IModelItem), setAutoCleanupEnabled(boolean)

isLocationParameterInstanceSharingEnabled

boolean isLocationParameterInstanceSharingEnabled()

Gets a value indicating whether the LocationParameter instance should be shared referentially or cloned upon a call to getLocationParameterInstance(IPortOwner).

Returns:

true if the reference should be shared; false otherwise.

See Also:

getLocationParameterInstance(IPortOwner), getLocationParameter(), setLocationParameterInstanceSharingEnabled(boolean)

isStyleInstanceSharingEnabled

boolean isStyleInstanceSharingEnabled()

Gets a value indicating whether the Style instance should be shared referentially or cloned upon a call to getStyleInstance(IPortOwner).

Returns:

true if the reference should be shared; false otherwise.

See Also:

getStyleInstance(IPortOwner), getStyle(), setStyleInstanceSharingEnabled(boolean)

setAutoCleanupEnabled

void setAutoCleanupEnabled(boolean value)

Determines whether unused ports should automatically be removed from their owners as soon as no further edge is connected to them.

Parameters:

value - The AutoCleanupEnabled to set.

See Also:

IGraph.remove(com.yworks.yfiles.graph.IModelItem), isAutoCleanupEnabled()

setLocationParameter

void setLocationParameter(IPortLocationModelParameter value)

Sets the location model parameter to use for ports.

Depending on the setting of LocationParameterInstanceSharingEnabled, the getLocationParameterInstance(IPortOwner) method should return a clone of this instance or the very same instance.

Parameters:

value - The parameter to use as a template.

See Also:

isLocationParameterInstanceSharingEnabled(), getLocationParameterInstance(IPortOwner), getLocationParameter()

setLocationParameterInstanceSharingEnabled

void setLocationParameterInstanceSharingEnabled(boolean value)

Sets a value indicating whether the LocationParameter instance should be shared referentially or cloned upon a call to getLocationParameterInstance(IPortOwner).

Parameters:

value - true if the reference should be shared; false otherwise.

See Also:

getLocationParameterInstance(IPortOwner), getLocationParameter(), isLocationParameterInstanceSharingEnabled()

setStyle

void setStyle(IPortStyle value)

Sets the style to use for ports.

Depending on the setting of StyleInstanceSharingEnabled, the getStyleInstance(IPortOwner) method should return a clone of this instance or the very same instance.

Parameters:

value - The style to use as a template.

See Also:

isStyleInstanceSharingEnabled(), getStyle()

setStyleInstanceSharingEnabled

void setStyleInstanceSharingEnabled(boolean value)

Sets a value indicating whether the Style instance should be shared referentially or cloned upon a call to getStyleInstance(IPortOwner).

Parameters:

value - true if the reference should be shared; false otherwise.

See Also:

getStyleInstance(IPortOwner), getStyle(), isStyleInstanceSharingEnabled()