com.yworks.yfiles.graph

Class StripeDefaults

java.lang.Object

com.yworks.yfiles.graph.StripeDefaults

All Implemented Interfaces:

IStripeDefaults

public class StripeDefaults
extends Object
implements IStripeDefaults

A canonic implementation of the IStripeDefaults interface.

Constructor Summary

Constructors

Constructor and Description
StripeDefaults() Default constructor.

Method Summary

Modifier and Type	Method and Description
InsetsD	getInsets() Gets the default insets for a stripe.
ILabelDefaults	getLabels() Gets the defaults for labels at stripes.
double	getMinimumSize() Gets the default minimum stripe size.
double	getSize() Gets the default stripe size.
IStripeStyle	getStyle() Gets the style to use for stripes.
IStripeStyle	getStyleInstance() Factory method that returns a style instance for use with newly created stripes.
boolean	isStyleInstanceSharingEnabled() Gets a value indicating whether the Style instance should be shared referentially or cloned upon a call to IStripeDefaults.getStyleInstance().
void	setInsets(InsetsD value) Sets the default insets for a stripe.
void	setLabels(ILabelDefaults value) Sets the defaults for labels at stripes.
void	setMinimumSize(double value) Sets the default minimum stripe size.
void	setSize(double value) Sets the default stripe size.
void	setStyle(IStripeStyle value) Sets the style to use for stripes.
void	setStyleInstanceSharingEnabled(boolean value) Sets a value indicating whether the Style instance should be shared referentially or cloned upon a call to IStripeDefaults.getStyleInstance().

Methods inherited from class java.lang.Object

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

Constructor Detail

StripeDefaults

public StripeDefaults()

Default constructor.

This constructor sets the style to VoidNodeStyle.INSTANCE and the insets to InsetsD.EMPTY

Method Detail

getInsets

public final InsetsD getInsets()

Gets the default insets for a stripe.

Specified by:

getInsets in interface IStripeDefaults

Returns:

The default insets.

See Also:

setInsets(InsetsD)

getLabels

public final ILabelDefaults getLabels()

Description copied from interface: IStripeDefaults

Gets the defaults for labels at stripes.

Specified by:

getLabels in interface IStripeDefaults

Returns:

The label defaults.

See Also:

IStripeDefaults.setLabels(ILabelDefaults)

getMinimumSize

public final double getMinimumSize()

Gets the default minimum stripe size.

Specified by:

getMinimumSize in interface IStripeDefaults

Returns:

The default minimum size of newly created stripes. Default value is 10

See Also:

IStripe.getMinimumSize(), setMinimumSize(double)

getSize

public final double getSize()

Gets the default stripe size.

Specified by:

getSize in interface IStripeDefaults

Returns:

The default size of newly created stripe. Default value is 100

See Also:

IStripe.getSize(), setSize(double)

getStyle

public final IStripeStyle getStyle()

Description copied from interface: IStripeDefaults

Gets the style to use for stripes.

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

Specified by:

getStyle in interface IStripeDefaults

Returns:

The style to use as a template.

See Also:

IStripeDefaults.isStyleInstanceSharingEnabled(), IStripeDefaults.setStyle(IStripeStyle)

getStyleInstance

public IStripeStyle getStyleInstance()

Description copied from interface: IStripeDefaults

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

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 IStripeDefaults

Returns:

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

isStyleInstanceSharingEnabled

public final boolean isStyleInstanceSharingEnabled()

Description copied from interface: IStripeDefaults

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

Specified by:

isStyleInstanceSharingEnabled in interface IStripeDefaults

Returns:

true if the reference should be shared; false otherwise.

See Also:

IStripeDefaults.getStyleInstance(), IStripeDefaults.getStyle(), IStripeDefaults.setStyleInstanceSharingEnabled(boolean)

setInsets

public final void setInsets(InsetsD value)

Sets the default insets for a stripe.

Specified by:

setInsets in interface IStripeDefaults

Parameters:

value - The default insets.

See Also:

getInsets()

setLabels

public final void setLabels(ILabelDefaults value)

Description copied from interface: IStripeDefaults

Sets the defaults for labels at stripes.

Specified by:

setLabels in interface IStripeDefaults

Parameters:

value - The label defaults.

See Also:

IStripeDefaults.getLabels()

setMinimumSize

public final void setMinimumSize(double value)

Sets the default minimum stripe size.

Specified by:

setMinimumSize in interface IStripeDefaults

Parameters:

value - The default minimum size of newly created stripes. Default value is 10

See Also:

IStripe.getMinimumSize(), getMinimumSize()

setSize

public final void setSize(double value)

Sets the default stripe size.

Specified by:

setSize in interface IStripeDefaults

Parameters:

value - The default size of newly created stripe. Default value is 100

See Also:

IStripe.getSize(), getSize()

setStyle

public final void setStyle(IStripeStyle value)

Description copied from interface: IStripeDefaults

Sets the style to use for stripes.

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

Specified by:

setStyle in interface IStripeDefaults

Parameters:

value - The style to use as a template.

See Also:

IStripeDefaults.isStyleInstanceSharingEnabled(), IStripeDefaults.getStyle()

setStyleInstanceSharingEnabled

public final void setStyleInstanceSharingEnabled(boolean value)

Description copied from interface: IStripeDefaults

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

Specified by:

setStyleInstanceSharingEnabled in interface IStripeDefaults

Parameters:

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

See Also:

IStripeDefaults.getStyleInstance(), IStripeDefaults.getStyle(), IStripeDefaults.isStyleInstanceSharingEnabled()