|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object bibliothek.gui.dock.event.VetoableDockFrontendEvent
public class VetoableDockFrontendEvent
Event that is received by a VetoableDockFrontendListener
.
Constructor Summary | |
---|---|
VetoableDockFrontendEvent(DockFrontend frontend,
boolean cancelable,
boolean expected,
Dockable... dockables)
Creates a new event |
Method Summary | |
---|---|
void |
cancel()
Aborts the operation. |
Dockable |
getDockable(int index)
Gets an element which will be or is hidden. |
int |
getDockableCount()
Gets the number of Dockable s which are in this event. |
Dockable[] |
getDockables()
Gets all the elements that are used in this event. |
DockFrontend |
getFrontend()
Gets the source of the event. |
boolean |
isCancelable()
Tells whether the operation can be canceled or not. |
boolean |
isCanceled()
Whether the operation is aborted or not. |
boolean |
isExpected()
Tells whether VetoableDockFrontendListener.hiding(VetoableDockFrontendEvent)
or VetoableDockFrontendListener.showing(VetoableDockFrontendEvent)
was called for this event or not.If true then this is a standard expected event that either happens
when the user clicks onto the close-action delivered by DockFrontend ,
or if the client calls DockFrontend.hide(Dockable, boolean) or
DockFrontend.show(Dockable, boolean) .If false then this is an unexpected event that can have
any cause, e.g. |
Iterator<Dockable> |
iterator()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public VetoableDockFrontendEvent(DockFrontend frontend, boolean cancelable, boolean expected, Dockable... dockables)
frontend
- the source of the eventcancelable
- whether the operation can be abortedexpected
- whether the event is expected or unexpecteddockables
- the elements which will be or is hidden, at least one entry
is requiredMethod Detail |
---|
public DockFrontend getFrontend()
null
public int getDockableCount()
Dockable
s which are in this event.
public Dockable getDockable(int index)
index
- the index of the element, the index 0
is always
valid.
null
public Dockable[] getDockables()
public Iterator<Dockable> iterator()
iterator
in interface Iterable<Dockable>
public boolean isCancelable()
VetoableDockFrontendListener.hiding(VetoableDockFrontendEvent)
will be ignored.
true
if the operation can be stoppedpublic void cancel()
isCancelable()
returns false
or the operation is already executed.
public boolean isCanceled()
true
if the operation is abortedpublic boolean isExpected()
VetoableDockFrontendListener.hiding(VetoableDockFrontendEvent)
or VetoableDockFrontendListener.showing(VetoableDockFrontendEvent)
was called for this event or not.true
then this is a standard expected event that either happens
when the user clicks onto the close-action delivered by DockFrontend
,
or if the client calls DockFrontend.hide(Dockable, boolean)
or
DockFrontend.show(Dockable, boolean)
.false
then this is an unexpected event that can have
any cause, e.g. loading a new layout.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |