com.jidesoft.editor.folding
Class FoldingSpanEvent

java.lang.Object
  java.util.EventObject
      com.jidesoft.editor.folding.FoldingSpanEvent

All Implemented Interfaces:

Serializable

public class FoldingSpanEvent
extends EventObject

A event to represent a change in the folding model.

See Also:

Serialized Form

Field Summary

static int	FOLDING_SPAN_ADDED A folding span is added.
static int	FOLDING_SPAN_COLLAPSED A folding span is collapsed.
static int	FOLDING_SPAN_END_ADJUSTING This event is used to signal the folding model is done adjusting.
static int	FOLDING_SPAN_EXPANDED A folding span is expanded.
static int	FOLDING_SPAN_REMOVED A folding span is removed.
static int	FOLDING_SPAN_START_ADJUSTING This event is used to signal the folding model starts to adjust.
static int	FOLDING_SPAN_UPDATED A folding span is updated.

Fields inherited from class java.util.EventObject

source

Constructor Summary

FoldingSpanEvent(Object source, FoldingSpan foldingSpan, int type, boolean adjusting)

Method Summary

FoldingSpan	getFoldingSpan()
int	getType()
static String	getTypeName(int type)
boolean	isAdjusting()
String	toString()

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

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

Field Detail

FOLDING_SPAN_ADDED

public static final int FOLDING_SPAN_ADDED

A folding span is added. The getFoldingSpan() method will give the folding span that is just added.

See Also:

Constant Field Values

FOLDING_SPAN_REMOVED

public static final int FOLDING_SPAN_REMOVED

A folding span is removed. The getFoldingSpan() method will give the folding span that is just removed.

See Also:

Constant Field Values

FOLDING_SPAN_UPDATED

public static final int FOLDING_SPAN_UPDATED

A folding span is updated. The getFoldingSpan() method will give the folding span that is just updated.

See Also:

Constant Field Values

FOLDING_SPAN_EXPANDED

public static final int FOLDING_SPAN_EXPANDED

A folding span is expanded. The getFoldingSpan() method will give the folding span that is just expanded.

See Also:

Constant Field Values

FOLDING_SPAN_COLLAPSED

public static final int FOLDING_SPAN_COLLAPSED

A folding span is collapsed. The getFoldingSpan() method will give the folding span that is just collapsed.

See Also:

Constant Field Values

FOLDING_SPAN_START_ADJUSTING

public static final int FOLDING_SPAN_START_ADJUSTING

This event is used to signal the folding model starts to adjust. There should be more events to indicate the changes but they will be all adjusting events until a FOLDING_SPAN_END_ADJUSTING event is received. In this event, getFoldingSpan() is always null and isAdjusting is always true.

See Also:

Constant Field Values

FOLDING_SPAN_END_ADJUSTING

public static final int FOLDING_SPAN_END_ADJUSTING

This event is used to signal the folding model is done adjusting. In this event, getFoldingSpan() is always null and isAdjusting is always false.

See Also:

Constant Field Values

Constructor Detail

FoldingSpanEvent

public FoldingSpanEvent(Object source,
                        FoldingSpan foldingSpan,
                        int type,
                        boolean adjusting)

Method Detail

getFoldingSpan

public FoldingSpan getFoldingSpan()

isAdjusting

public boolean isAdjusting()

getType

public int getType()

getTypeName

public static String getTypeName(int type)

toString

public String toString()

Overrides:

toString in class EventObject