com.yworks.yfiles.graph

Class PortDefaults

java.lang.Object

com.yworks.yfiles.graph.PortDefaults

All Implemented Interfaces:

IPortDefaults

public class PortDefaults
extends Object
implements IPortDefaults

A canonic implementation of the IPortDefaults interface.

Constructor Summary

Constructors

Constructor and Description
PortDefaults() Initializes a new instance of the PortDefaults class using a trivial location model parameter.

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() Factory method that returns a style instance for use with newly created 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 IPortDefaults.getLocationParameterInstance(IPortOwner).
boolean	isStyleInstanceSharingEnabled() Gets a value indicating whether the Style instance should be shared referentially or cloned upon a call to IPortDefaults.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 IPortDefaults.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 IPortDefaults.getStyleInstance(IPortOwner).

Methods inherited from class java.lang.Object

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

Constructor Detail

PortDefaults

public PortDefaults()

Initializes a new instance of the PortDefaults class using a trivial location model parameter.

Method Detail

getLocationParameter

public final IPortLocationModelParameter getLocationParameter()

Description copied from interface: IPortDefaults

Gets the location model parameter to use for ports.

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

Specified by:

getLocationParameter in interface IPortDefaults

Returns:

The parameter to use as a template.

See Also:

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

getLocationParameterInstance

public IPortLocationModelParameter getLocationParameterInstance(IPortOwner owner)

Description copied from interface: IPortDefaults

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.

Specified by:

getLocationParameterInstance in interface IPortDefaults

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

public final IPortStyle getStyle()

Description copied from interface: IPortDefaults

Gets the style to use for ports.

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

Specified by:

getStyle in interface IPortDefaults

Returns:

The style to use as a template.

See Also:

IPortDefaults.isStyleInstanceSharingEnabled(), IPortDefaults.setStyle(IPortStyle)

getStyleInstance

public IPortStyle getStyleInstance()

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.

Returns:

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

getStyleInstance

public IPortStyle getStyleInstance(IPortOwner owner)

Description copied from interface: IPortDefaults

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.

Specified by:

getStyleInstance in interface IPortDefaults

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

public final boolean isAutoCleanupEnabled()

Description copied from interface: IPortDefaults

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

Specified by:

isAutoCleanupEnabled in interface IPortDefaults

Returns:

The AutoCleanupEnabled.

See Also:

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

isLocationParameterInstanceSharingEnabled

public final boolean isLocationParameterInstanceSharingEnabled()

Description copied from interface: IPortDefaults

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

Specified by:

isLocationParameterInstanceSharingEnabled in interface IPortDefaults

Returns:

true if the reference should be shared; false otherwise.

See Also:

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

isStyleInstanceSharingEnabled

public final boolean isStyleInstanceSharingEnabled()

Description copied from interface: IPortDefaults

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

Specified by:

isStyleInstanceSharingEnabled in interface IPortDefaults

Returns:

true if the reference should be shared; false otherwise.

See Also:

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

setAutoCleanupEnabled

public final void setAutoCleanupEnabled(boolean value)

Description copied from interface: IPortDefaults

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

Specified by:

setAutoCleanupEnabled in interface IPortDefaults

Parameters:

value - The AutoCleanupEnabled to set.

See Also:

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

setLocationParameter

public final void setLocationParameter(IPortLocationModelParameter value)

Description copied from interface: IPortDefaults

Sets the location model parameter to use for ports.

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

Specified by:

setLocationParameter in interface IPortDefaults

Parameters:

value - The parameter to use as a template.

See Also:

IPortDefaults.isLocationParameterInstanceSharingEnabled(), IPortDefaults.getLocationParameterInstance(IPortOwner), IPortDefaults.getLocationParameter()

setLocationParameterInstanceSharingEnabled

public final void setLocationParameterInstanceSharingEnabled(boolean value)

Description copied from interface: IPortDefaults

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

Specified by:

setLocationParameterInstanceSharingEnabled in interface IPortDefaults

Parameters:

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

See Also:

IPortDefaults.getLocationParameterInstance(IPortOwner), IPortDefaults.getLocationParameter(), IPortDefaults.isLocationParameterInstanceSharingEnabled()

setStyle

public final void setStyle(IPortStyle value)

Description copied from interface: IPortDefaults

Sets the style to use for ports.

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

Specified by:

setStyle in interface IPortDefaults

Parameters:

value - The style to use as a template.

See Also:

IPortDefaults.isStyleInstanceSharingEnabled(), IPortDefaults.getStyle()

setStyleInstanceSharingEnabled

public final void setStyleInstanceSharingEnabled(boolean value)

Description copied from interface: IPortDefaults

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

Specified by:

setStyleInstanceSharingEnabled in interface IPortDefaults

Parameters:

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

See Also:

IPortDefaults.getStyleInstance(IPortOwner), IPortDefaults.getStyle(), IPortDefaults.isStyleInstanceSharingEnabled()