Package docking.widgets.fieldpanel
Class FieldPanelOverLayoutEvent
java.lang.Object
docking.widgets.fieldpanel.FieldPanelOverLayoutEvent
An event related to component layout over a
FieldPanel
.- See Also:
-
Constructor Summary
ConstructorDescriptionFieldPanelOverLayoutEvent
(Field field, FieldLocation loc, Component component) Create a new event on the given field, location, and component. -
Method Summary
Modifier and TypeMethodDescriptionvoid
cancel()
Prevent the actual layout from taking place.void
consume()
Prevent this event from being further processed.Get the component to be placed over the fieldgetField()
Get the field that will have a component placed over itGet the field locationboolean
Check if the actual layout will be performed.boolean
Check if this event has been consumed by an earlier listener.
-
Constructor Details
-
FieldPanelOverLayoutEvent
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 Details
-
getField
Get the field that will have a component placed over it- Returns:
- the field
-
getLocation
Get the field location- Returns:
- the location of the field
-
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.
-