Package docking.widgets.fieldpanel
Class FieldPanelOverLayoutEvent
- java.lang.Object
-
- docking.widgets.fieldpanel.FieldPanelOverLayoutEvent
-
public class FieldPanelOverLayoutEvent extends java.lang.Object
An event related to component layout over aFieldPanel
.- See Also:
FieldPanelOverLayoutManager
-
-
Constructor Summary
Constructors Constructor Description FieldPanelOverLayoutEvent(Field field, FieldLocation loc, java.awt.Component component)
Create a new event on the given field, location, and component.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
cancel()
Prevent the actual layout from taking place.void
consume()
Prevent this event from being further processed.java.awt.Component
getComponent()
Get the component to be placed over the fieldField
getField()
Get the field that will have a component placed over itFieldLocation
getLocation()
Get the field locationboolean
isCancelled()
Check if the actual layout will be performed.boolean
isConsumed()
Check if this event has been consumed by an earlier listener.
-
-
-
Constructor Detail
-
FieldPanelOverLayoutEvent
public FieldPanelOverLayoutEvent(Field field, FieldLocation loc, java.awt.Component component)
Create a new event on the given field, location, and component.- Parameters:
field
- the field that will have a component placed over itloc
- the location of the fieldcomponent
- the component to be placed over the field
-
-
Method Detail
-
getField
public Field getField()
Get the field that will have a component placed over it- Returns:
- the field
-
getLocation
public FieldLocation getLocation()
Get the field location- Returns:
- the location of the field
-
getComponent
public java.awt.Component getComponent()
Get the component to be placed over the field- Returns:
- the component
-
consume
public void consume()
Prevent this event from being further processed. The actual layout will still occur, though.
-
isConsumed
public boolean isConsumed()
Check if this event has been consumed by an earlier listener.- Returns:
- true if the event has been consumed, i.e., should not be further processed
-
cancel
public void cancel()
Prevent the actual layout from taking place. Further listeners may still process this event, though.
-
isCancelled
public boolean isCancelled()
Check if the actual layout will be performed.- Returns:
- true if the layout has been cancelled.
-
-