org.apache.jetspeed.portlets.layout
Class LayoutEvent

java.lang.Object
  org.apache.jetspeed.portlets.layout.LayoutEvent

public class LayoutEvent
extends Object

A LayoutEvent is used by ColumnLayout to notify its LayoutAeventListeners that there have been a change in the position of a fragment within the layout.

Constant Values

• ADDED == 0
• MOVED_UP == 1
• MOVED_DOWN == 2
• MOVED_LEFT == 3
• MOVED_RIGHT == 4

Author:

Scott T. Weaver

See Also:

Fragment, LayoutEventListener, ColumnLayout

Field Summary

static int	ADDED Event type value that notifies that a fragment has been added
private int	eventType
private org.apache.jetspeed.om.page.Fragment	fragment
static int	MOVED_DOWN Event type value that notifies that a fragment has been moved down
static int	MOVED_LEFT Event type value that notifies that a fragment has been moved left
static int	MOVED_RIGHT Event type value that notifies that a fragment has been moved right
static int	MOVED_UP Event type value that notifies that a fragment has been moved up
private LayoutCoordinate	newCoordinate
private LayoutCoordinate	originalCoordinate

Constructor Summary

LayoutEvent(int eventType, org.apache.jetspeed.om.page.Fragment fragment, LayoutCoordinate originalCoordinate, LayoutCoordinate newCoordinate)

Method Summary

boolean	equals(Object obj)
int	getEventType() Returns the event type (see event constants)
org.apache.jetspeed.om.page.Fragment	getFragment() Returns the fragment that is the target of this event.
LayoutCoordinate	getNewCoordinate() Returns the new/current coordinate of the Fragment targeted by this event.
LayoutCoordinate	getOriginalCoordinate() Returns the original (prior to the event) coordinate of the Fragment targeted by this event.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

ADDED

public static final int ADDED

Event type value that notifies that a fragment has been added

See Also:

Constant Field Values

MOVED_UP

public static final int MOVED_UP

Event type value that notifies that a fragment has been moved up

See Also:

Constant Field Values

MOVED_DOWN

public static final int MOVED_DOWN

Event type value that notifies that a fragment has been moved down

See Also:

Constant Field Values

MOVED_LEFT

public static final int MOVED_LEFT

Event type value that notifies that a fragment has been moved left

See Also:

Constant Field Values

MOVED_RIGHT

public static final int MOVED_RIGHT

Event type value that notifies that a fragment has been moved right

See Also:

Constant Field Values

eventType

private final int eventType

fragment

private final org.apache.jetspeed.om.page.Fragment fragment

originalCoordinate

private final LayoutCoordinate originalCoordinate

newCoordinate

private final LayoutCoordinate newCoordinate

Constructor Detail

LayoutEvent

public LayoutEvent(int eventType,
                   org.apache.jetspeed.om.page.Fragment fragment,
                   LayoutCoordinate originalCoordinate,
                   LayoutCoordinate newCoordinate)

Parameters:

eventType - The type of event (see the event constants)

fragment - Fragment that is the target of this event.

originalCoordinate - the previous LayoutCoordinate of this Fragment

newCoordinate - the new and current coordinates of this fragment.

See Also:

Fragment

Method Detail

getEventType

public int getEventType()

Returns the event type (see event constants)

Returns:

the event type (see event constants)

See Also:

ColumnLayout#layoutType

getFragment

public org.apache.jetspeed.om.page.Fragment getFragment()

Returns the fragment that is the target of this event.

Returns:

Fragment the fragment that is the target of this event.

See Also:

Fragment

getNewCoordinate

public LayoutCoordinate getNewCoordinate()

Returns the new/current coordinate of the Fragment targeted by this event.

Returns:

the new/current coordinate of the Fragment targeted by this event.

See Also:

LayoutCoordinate

getOriginalCoordinate

public LayoutCoordinate getOriginalCoordinate()

Returns the original (prior to the event) coordinate of the Fragment targeted by this event.

Returns:

the original (prior to the event) coordinate of the Fragment targeted by this event.

See Also:

LayoutCoordinate

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object