public class StationCombinerValue extends StationThemeItemValue<Combiner> implements CombinerValue, Combiner
StationCombinerValue encloses a Combiner and uses
the combiner as delegate. If the wrapper has no delegate, it uses
the DockUI to get a combiner from the current DockTheme.| Modifier and Type | Field and Description |
|---|---|
static Path |
KIND_STATION
What kind of
UIValue this is |
KIND_COMBINER| Constructor and Description |
|---|
StationCombinerValue(String id,
DockStation station)
Creates a new value.
|
| Modifier and Type | Method and Description |
|---|---|
void |
aside(AsideRequest request)
Prepares the layout of the
DockStations 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
Dockables into a new Dockable. |
CombinerTarget |
prepare(CombinerSource source,
Enforcement force)
Prepares information telling how two
Dockables may be combined. |
get, getDelegate, getStation, set, setController, setDelegateclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetStationpublic StationCombinerValue(String id, DockStation station)
id - the identifier of this value, used to read a resource from the ThemeManagerstation - the owner of this objectpublic CombinerTarget prepare(CombinerSource source, Enforcement force)
CombinerDockables may be combined.prepare in interface Combinersource - the Dockables 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.Dockables, may be null to indicate that
a combination is not desiredpublic Dockable combine(CombinerSource source, CombinerTarget target)
CombinerDockables into a new Dockable. This method may
set the DockController of the created element in order to initialize
it more efficiently.combine in interface Combinersource - information about the two Dockables 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 Combiner.prepare(CombinerSource, Enforcement) using source, not nullDockable, not nullpublic void aside(AsideRequest request)
CombinerDockStations 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().aside in interface Combinerrequest - information about a location and methods to create the neighbor locationDockStation.aside(AsideRequest)Copyright © 2017 Docking Frames. All rights reserved.