|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object bibliothek.gui.dock.util.DockUtilities
public class DockUtilities
A list of methods which can be used for different purposes. Methods
related to the DockTheme
can be found in DockUI
.
Nested Class Summary | |
---|---|
static class |
DockUtilities.DockVisitor
A visitor used to visit the nodes of a dock-tree. |
Constructor Summary | |
---|---|
DockUtilities()
|
Method Summary | |
---|---|
static boolean |
acceptable(DockStation parent,
Dockable child)
Tells whether the Dockable child can be dropped over
parent . |
static boolean |
acceptable(DockStation parent,
Dockable old,
Dockable next)
Tells whether the Dockable next can be dropped over old . |
static DockableProperty |
append(DockableProperty root,
DockableProperty property)
Creates a copy of root and sets property
as the successor of the very last element in the property chain beginning
at root . |
static void |
checkLayoutLocked()
Searches for a class or interface that is marked with LayoutLocked in the current
callstack and prints a warning if found. |
static void |
disableCheckLayoutLocked()
Ensures that checkLayoutLocked() never prints out any warnings. |
static Icon |
disabledIcon(JComponent parent,
Icon icon)
Gets a "disabled" icon according to the current look and feel. |
static void |
ensureTreeValidity(DockStation newParent,
Dockable newChild)
Ensures that newChild has no parent, and that there will
be no cycle when newChild is added to newParent |
static void |
ensureTreeValidity(PerspectiveStation newParent,
PerspectiveDockable newChild)
Ensures that newChild has either no parent or newParent as parent, and that there will
be no cycle when newChild is added to newParent |
static Dockable |
getDirectChild(DockStation parent,
Dockable subchild)
Searches the one Dockable that is either subchild or a parent
of subchild and whose parent is parent . |
static DockableProperty |
getLastProperty(DockableProperty property)
Gets the last successor in the property chain beginning at property . |
static DockableProperty |
getPropertyChain(Dockable dockable)
Gets a DockableProperty which describes the path from the
root to dockable . |
static DockableProperty |
getPropertyChain(DockStation ground,
Dockable dockable)
Creates a DockableProperty describing the path from
ground to dockable . |
static DockableProperty |
getPropertyChain(PerspectiveStation ground,
PerspectiveDockable dockable)
Creates a DockableProperty describing the path from
ground to dockable . |
static DockStation |
getRoot(DockElement element)
Searches the station which is an ancestor of element
and has no parent. |
static Component |
getShowingComponent(Dockable dockable)
Searches a Component which is showing
and has something to do with dockable .This method first checks Dockable and DockTitle s, then it checks
all DockElementRepresentative s. |
static Image |
iconImage(Icon icon)
Transforms icon into an image. |
static boolean |
isAncestor(DockElement ancestor,
DockElement child)
Tells whether child is identical with ancestor
or a child of ancestor . |
static boolean |
isAncestor(PerspectiveElement ancestor,
PerspectiveElement child)
Tells whether child is identical with ancestor
or a child of ancestor . |
static List<Dockable> |
listDockables(DockElement root,
boolean includeRoot)
Lists all Dockable s in the tree under root . |
static Map<String,Icon> |
loadIcons(String list,
String path,
ClassLoader loader)
Loads a map of icons. |
static Map<String,Icon> |
loadIcons(String list,
String path,
Set<String> ignore,
ClassLoader loader)
Loads a map of icons. |
static Path[] |
mergePlaceholders(Path[] base,
Dockable dockable,
PlaceholderStrategy strategy)
Merges the array base with the placeholder that is associated with dockable , but
only if that placeholder is not yet in base . |
static void |
visit(Dockable dockable,
DockUtilities.DockVisitor visitor)
Visits dockable and all its children. |
static void |
visit(DockElement element,
DockUtilities.DockVisitor visitor)
Visits element and all its children. |
static void |
visit(DockStation station,
DockUtilities.DockVisitor visitor)
Visits station and all its children. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DockUtilities()
Method Detail |
---|
public static void visit(Dockable dockable, DockUtilities.DockVisitor visitor)
dockable
and all its children.
dockable
- the first element to visitvisitor
- a delegatepublic static void visit(DockStation station, DockUtilities.DockVisitor visitor)
station
and all its children.
station
- the first element to visitvisitor
- a delegatepublic static void visit(DockElement element, DockUtilities.DockVisitor visitor)
element
and all its children.
element
- the first element to visitvisitor
- a delegatepublic static List<Dockable> listDockables(DockElement root, boolean includeRoot)
Dockable
s in the tree under root
.
root
- the root of a tree of elementsincludeRoot
- whether root
should be in the resulting
list as well
Dockable
s, might be empty but not null
public static boolean isAncestor(DockElement ancestor, DockElement child)
child
is identical with ancestor
or a child of ancestor
.
ancestor
- an elementchild
- another element
true
if ancestor
is a parent of or
identical with child
.public static boolean isAncestor(PerspectiveElement ancestor, PerspectiveElement child)
child
is identical with ancestor
or a child of ancestor
.
ancestor
- an elementchild
- another element
true
if ancestor
is a parent of or
identical with child
.public static DockStation getRoot(DockElement element)
element
and has no parent.
element
- the element whose oldest parent is searched
null
if element has no parentpublic static Dockable getDirectChild(DockStation parent, Dockable subchild)
Dockable
that is either subchild
or a parent
of subchild
and whose parent is parent
.
parent
- the parent of the resultsubchild
- a direct or indirect child of parent
null
if subchild is no child of parent
public static DockableProperty append(DockableProperty root, DockableProperty property)
root
and sets property
as the successor of the very last element in the property chain beginning
at root
.
root
- the root of the chain, can be null
property
- the new last element of the chain
public static DockableProperty getLastProperty(DockableProperty property)
property
.
property
- the start of the chain
public static DockableProperty getPropertyChain(Dockable dockable)
DockableProperty
which describes the path from the
root
to dockable
.
dockable
- a Dockable whose location is searched
null
if dockable
has no parentpublic static DockableProperty getPropertyChain(DockStation ground, Dockable dockable)
DockableProperty
describing the path from
ground
to dockable
.
ground
- the base of the propertydockable
- an indirect child of ground
ground
to dockable
.
IllegalArgumentException
- if ground
is not an
ancestor of dockable
public static DockableProperty getPropertyChain(PerspectiveStation ground, PerspectiveDockable dockable)
DockableProperty
describing the path from
ground
to dockable
.
ground
- the base of the propertydockable
- an indirect child of ground
ground
to dockable
.
IllegalArgumentException
- if ground
is not an
ancestor of dockable
public static Component getShowingComponent(Dockable dockable)
Component
which is showing
and has something to do with dockable
.Dockable
and DockTitle
s, then it checks
all DockElementRepresentative
s.
dockable
- a Dockable for which a Component has to be found
null
public static void ensureTreeValidity(DockStation newParent, Dockable newChild)
newChild
has no parent, and that there will
be no cycle when newChild
is added to newParent
newParent
- the element that becomes parent of newChild
newChild
- the element that becomes child of newParent
NullPointerException
- if either newParent
or newChild
is null
IllegalArgumentException
- if there would be a cycle introduced
IllegalStateException
- if the old parent of newChild
does not
allow to remove its childpublic static void ensureTreeValidity(PerspectiveStation newParent, PerspectiveDockable newChild)
newChild
has either no parent or newParent
as parent, and that there will
be no cycle when newChild
is added to newParent
newParent
- the element that becomes parent of newChild
newChild
- the element that becomes child of newParent
NullPointerException
- if either newParent
or newChild
is null
IllegalArgumentException
- if there would be a cycle introduced
IllegalStateException
- if the old parent of newChild
does not
allow to remove its childpublic static Icon disabledIcon(JComponent parent, Icon icon)
parent
- the component on which the icon will be painted, can be null
icon
- an icon or null
icon
or null
public static Image iconImage(Icon icon)
icon
into an image.
icon
- some icon
null
public static Map<String,Icon> loadIcons(String list, String path, ClassLoader loader)
list
- a path to a property-file containing key-path-pairs.path
- the base path to the icons, will be added before any
path of the property file, can be null
loader
- used to transform paths into urls.
Icon
s, the map can be empty if no icons were foundProperties.load(InputStream)
public static Map<String,Icon> loadIcons(String list, String path, Set<String> ignore, ClassLoader loader)
list
- a path to a property-file containing key-path-pairs.path
- the base path to the icons, will be added before any
path of the property file, can be null
ignore
- keys that are already present in ignore
are not loaded, can be null
loader
- used to transform paths into urls.
Icon
s, the map can be empty if no icons were foundProperties.load(InputStream)
public static Path[] mergePlaceholders(Path[] base, Dockable dockable, PlaceholderStrategy strategy)
base
with the placeholder that is associated with dockable
, but
only if that placeholder is not yet in base
.
base
- some basic array, can be null
dockable
- the dockable whose placeholder is to be stored, can be null
strategy
- a strategy to find the placeholder of dockable
, can be null
base
, base
itself, or null
if
base
was null
and no additional placeholder was foundpublic static boolean acceptable(DockStation parent, Dockable child)
Dockable
child
can be dropped over
parent
.
parent
- the new parentchild
- the new child
true
if the parent and the child accept each otherpublic static boolean acceptable(DockStation parent, Dockable old, Dockable next)
Dockable
next
can be dropped over old
.
parent
- the parent of old
old
- the existing childnext
- the new child
true
if the parent and the child accept each otherpublic static void disableCheckLayoutLocked()
checkLayoutLocked()
never prints out any warnings.
public static void checkLayoutLocked()
LayoutLocked
in the current
callstack and prints a warning if found.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |