|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Combiner
A Combiner
merges two Dockables
into
one Dockable
. How this is done, is up to the Combiner, but
most Combiners will create a new DockStation
and put the Dockables
onto this new station.
Merger
,
Inserter
Method Summary | |
---|---|
void |
aside(AsideRequest request)
Prepares the layout of the DockStation s that are created by this Combiner to
keep track of a new DockableProperty with its own placeholder. |
Dockable |
combine(CombinerSource source,
CombinerTarget target)
Merges two Dockable s into a new Dockable. |
CombinerTarget |
prepare(CombinerSource source,
Enforcement force)
Prepares information telling how two Dockable s may be combined. |
Method Detail |
---|
CombinerTarget prepare(CombinerSource source, Enforcement force)
Dockable
s may be combined.
source
- the Dockable
s which may be combined, their parent station and
other helpful information.force
- how much the caller of this method would like the method not to return a
value of null
. Implementations should read the force
property, where a value of 1
means that this method must success, while 0
means that this method may or may not success. In general the modules in the framework expect that a value below
0.5
results in null
, while a value above 0.5f
results in a non-null
value.
Dockable
s, may be null
to indicate that
a combination is not desiredDockable combine(CombinerSource source, CombinerTarget target)
Dockable
s into a new Dockable. This method may
set the DockController
of the created element in order to initialize
it more efficiently.
source
- information about the two Dockable
s that are going to be merged, not null
. This
object may or may not have been created by this Combiner
, some sanity checks are advised before using ittarget
- information that was created by prepare(CombinerSource, Enforcement)
using source
, not null
Dockable
, not null
void aside(AsideRequest request)
DockStation
s that are created by this Combiner
to
keep track of a new DockableProperty
with its own placeholder. The new property
is set "aside" an existing location. For more information please read the documentation
of DockElement.asDockable()
.
request
- information about a location and methods to create the neighbor locationDockStation.aside(AsideRequest)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |