com.jidesoft.editor
Interface EffectStyle

All Superinterfaces:

Style

All Known Implementing Classes:

SyntaxStyle

public interface EffectStyle
extends Style

EffectStyle is an interface for special effects. It's really up to you to define all the effects. Right now we have underline, waved, strike through, bordered effects.

Field Summary

static int	EFFECT_BORDERED
static int	EFFECT_NONE
static int	EFFECT_STRIKE_THROUGH
static int	EFFECT_UNDERLINE
static int	EFFECT_WAVED

Method Summary

int	getEffect() Gets the effect.
Color	getEffectColor() Gets the effect color.
Color	getStripeColor() Gets the stripe color.
void	setEffect(int effect) Sets the effect.
void	setEffectColor(Color effectColor) Sets the color of the effect.
void	setStripeColor(Color stripeColor) Sets the stripe color.

Field Detail

EFFECT_NONE

static final int EFFECT_NONE

See Also:

Constant Field Values

EFFECT_UNDERLINE

static final int EFFECT_UNDERLINE

See Also:

Constant Field Values

EFFECT_WAVED

static final int EFFECT_WAVED

See Also:

Constant Field Values

EFFECT_STRIKE_THROUGH

static final int EFFECT_STRIKE_THROUGH

See Also:

Constant Field Values

EFFECT_BORDERED

static final int EFFECT_BORDERED

See Also:

Constant Field Values

Method Detail

setEffect

void setEffect(int effect)

Sets the effect.

Parameters:

effect - the new effect.

getEffect

int getEffect()

Gets the effect.

Returns:

the effect.

setEffectColor

void setEffectColor(Color effectColor)

Sets the color of the effect. For example, if the effect is a underline, the color will be used to paint the line.

Parameters:

effectColor - the new effect color.

getEffectColor

Color getEffectColor()

Gets the effect color.

Returns:

the effect color.

setStripeColor

void setStripeColor(Color stripeColor)

Sets the stripe color. When a text has a special effect, you might also want to show a color stripe on the marker stripe area. This is the color that will be used.

Parameters:

stripeColor - the new stripe color. Null if you don't want to show any stripe for this effect.

getStripeColor

Color getStripeColor()

Gets the stripe color.

Returns:

the stripe color.