com.yworks.yfiles.graph

Interface IStripeDefaults

All Known Implementing Classes:

StripeDefaults

public interface IStripeDefaults

Interface used by ITable and the like to declare and obtain the defaults for stripes and their labels.

See Also:

ITable.getRowDefaults(), ITable.getColumnDefaults()

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 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 getStyleInstance().

Method Detail

getInsets

InsetsD getInsets()

Gets the default insets for a stripe.

Returns:

The default insets.

See Also:

setInsets(InsetsD)

getLabels

ILabelDefaults getLabels()

Gets the defaults for labels at stripes.

Returns:

The label defaults.

See Also:

setLabels(ILabelDefaults)

getMinimumSize

double getMinimumSize()

Gets the default minimum stripe size.

Returns:

The default minimum size of newly created stripes.

See Also:

IStripe.getMinimumSize(), setMinimumSize(double)

getSize

double getSize()

Gets the default stripe size.

Returns:

The default size of newly created stripe.

See Also:

IStripe.getSize(), setSize(double)

getStyle

IStripeStyle getStyle()

Gets the style to use for stripes.

Depending on the setting of StyleInstanceSharingEnabled, the getStyleInstance() 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(IStripeStyle)

getStyleInstance

IStripeStyle getStyleInstance()

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.

Returns:

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

isStyleInstanceSharingEnabled

boolean isStyleInstanceSharingEnabled()

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

Returns:

true if the reference should be shared; false otherwise.

See Also:

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

setInsets

void setInsets(InsetsD value)

Sets the default insets for a stripe.

Parameters:

value - The default insets.

See Also:

getInsets()

setLabels

void setLabels(ILabelDefaults value)

Sets the defaults for labels at stripes.

Parameters:

value - The label defaults.

See Also:

getLabels()

setMinimumSize

void setMinimumSize(double value)

Sets the default minimum stripe size.

Parameters:

value - The default minimum size of newly created stripes.

See Also:

IStripe.getMinimumSize(), getMinimumSize()

setSize

void setSize(double value)

Sets the default stripe size.

Parameters:

value - The default size of newly created stripe.

See Also:

IStripe.getSize(), getSize()

setStyle

void setStyle(IStripeStyle value)

Sets the style to use for stripes.

Depending on the setting of StyleInstanceSharingEnabled, the getStyleInstance() 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().

Parameters:

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

See Also:

getStyleInstance(), getStyle(), isStyleInstanceSharingEnabled()