|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object bibliothek.gui.dock.common.perspective.CExternalizePerspective
public class CExternalizePerspective
A representation of a CExternalizeArea
.
Nested Class Summary | |
---|---|
class |
CExternalizePerspective.CommonScreenDockPerspective
This type of object is used by the CExternalizePerspective as intern representation. |
Constructor Summary | |
---|---|
CExternalizePerspective(String id,
Path typeId)
Creates a new, empty perspective. |
Method Summary | |
---|---|
void |
add(CDockablePerspective dockable,
int x,
int y,
int width,
int height)
Adds dockable at location x/y with size width/height to
this area. |
void |
add(CDockablePerspective dockable,
int x,
int y,
int width,
int height,
boolean fullscreen)
Adds dockable at location x/y with size width/height to
this area. |
void |
add(CDockablePerspective dockable,
Rectangle bounds)
Adds dockable width boundaries bounds to this area. |
void |
add(CDockablePerspective dockable,
Rectangle bounds,
boolean fullscreen)
Adds dockable width boundaries bounds to this area. |
void |
addPlaceholder(CDockablePerspective dockable,
int x,
int y,
int width,
int height)
Adds a placeholder for dockable and all its children to this
area. |
void |
addPlaceholder(CDockablePerspective dockable,
Rectangle bounds)
Adds a placeholder for dockable and all its children to this
area. |
CDockablePerspective |
asDockable()
Gets this as dockable, if this is a dockable. |
CStationPerspective |
asStation()
Gets this as station, if this is a station. |
String |
getFactoryID()
|
CPerspective |
getPerspective()
Gets the perspective which presents this station. |
PlaceholderMap |
getPlaceholders()
|
Path |
getTypeId()
Gets the unique id denoting the type of this CStation , this should be the
exact same result as CStation.getTypeId() will return. |
String |
getUniqueId()
Gets the unique identifier of this station. |
ScreenDockPerspective.ScreenPerspectiveWindow |
getWindow(CDockablePerspective dockable)
Gets an object that stores all the properties that are associated with dockable . |
int |
indexOf(CDockablePerspective dockable)
Gets the location of dockable . |
CExternalizePerspective.CommonScreenDockPerspective |
intern()
Gets the internal representation for this element. If CElementPerspective.asDockable() returns a non-null value, then intern().asDockable() must not
return null either.If CElementPerspective.asStation() returns a non-null value, then intern().asStation() must not
return null either. |
boolean |
isRoot()
Tells whether this is a root station or not. |
boolean |
isWorkingArea()
Tells whether this station will act as a working area . |
boolean |
remove(CDockablePerspective dockable)
Removes dockable from this area. |
CDockablePerspective |
remove(int index)
Removes the index 'th dockable of this area. |
void |
setPerspective(CPerspective perspective)
Informs this station by which perspective it is used. |
void |
setPlaceholders(PlaceholderMap placeholders)
|
void |
setRoot(boolean root)
Sets the root station flag. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public CExternalizePerspective(String id, Path typeId)
id
- the unique identifier of this perspectivetypeId
- the type of this station, can be null
Method Detail |
---|
public String getUniqueId()
CStationPerspective
getUniqueId
in interface CStationPerspective
public Path getTypeId()
CStationPerspective
CStation
, this should be the
exact same result as CStation.getTypeId()
will return.
getTypeId
in interface CStationPerspective
null
public boolean isRoot()
CStationPerspective
isRoot
in interface CStationPerspective
CStationPerspective.setRoot(boolean)
public void setRoot(boolean root)
CStationPerspective
root
parameter when calling
CControl.addStation(bibliothek.gui.dock.common.CStation, boolean)
. The location of a Dockable
is
always relative to its nearest root-station parent.CControl.addStation(bibliothek.gui.dock.common.CStation, boolean)
will
never be overriden by the flag set in the perspective.
setRoot
in interface CStationPerspective
public void setPerspective(CPerspective perspective)
CStationPerspective
setPerspective
in interface CStationPerspective
perspective
- the perspective that uses this station or null
public CPerspective getPerspective()
CStationPerspective
getPerspective
in interface CStationPerspective
null
public void add(CDockablePerspective dockable, Rectangle bounds)
dockable
width boundaries bounds
to this area.
dockable
- the element to add, not null
bounds
- the boundaries of dockable
public void add(CDockablePerspective dockable, int x, int y, int width, int height)
dockable
at location x/y
with size width/height
to
this area.
dockable
- the element to add, not null
x
- the x-coordinate on the screeny
- the y-coordinate on the screenwidth
- the width of the windowheight
- the height of the windowpublic void add(CDockablePerspective dockable, Rectangle bounds, boolean fullscreen)
dockable
width boundaries bounds
to this area.
dockable
- the element to add, not null
bounds
- the boundaries of dockable
fullscreen
- whether dockable
should be extended to fullscreen modepublic void add(CDockablePerspective dockable, int x, int y, int width, int height, boolean fullscreen)
dockable
at location x/y
with size width/height
to
this area.
dockable
- the element to add, not null
x
- the x-coordinate on the screeny
- the y-coordinate on the screenwidth
- the width of the windowheight
- the height of the windowfullscreen
- whether dockable
should be extended to fullscreen modepublic void addPlaceholder(CDockablePerspective dockable, Rectangle bounds)
dockable
and all its children to this
area.
dockable
- the element whose placeholder should be insertedbounds
- the location and size of dockable
public void addPlaceholder(CDockablePerspective dockable, int x, int y, int width, int height)
dockable
and all its children to this
area.
dockable
- the element whose placeholder should be insertedx
- the x-coordinate on the screeny
- the y-coordinate on the screenwidth
- the width of the windowheight
- the height of the windowpublic ScreenDockPerspective.ScreenPerspectiveWindow getWindow(CDockablePerspective dockable)
dockable
.
dockable
- the element whose window is searched
null
if dockable
is not known to this areapublic boolean remove(CDockablePerspective dockable)
dockable
from this area.
dockable
- the element to remove
true
if dockable
was found and removed, false
otherwise.public CDockablePerspective remove(int index)
index
'th dockable of this area.
index
- the index of a child of this area
null
if the element is not a CDockablePerspective
public int indexOf(CDockablePerspective dockable)
dockable
.
dockable
- some child of this area
public CExternalizePerspective.CommonScreenDockPerspective intern()
CElementPerspective
CElementPerspective.asDockable()
returns a non-null
value, then intern().asDockable()
must not
return null
either.CElementPerspective.asStation()
returns a non-null
value, then intern().asStation()
must not
return null
either.
intern
in interface CElementPerspective
public CDockablePerspective asDockable()
CElementPerspective
this
as dockable, if this is a dockable.
asDockable
in interface CElementPerspective
this
or null
public CStationPerspective asStation()
CElementPerspective
this
as station, if this is a station.
asStation
in interface CElementPerspective
this
or null
public String getFactoryID()
public PlaceholderMap getPlaceholders()
public void setPlaceholders(PlaceholderMap placeholders)
public boolean isWorkingArea()
CStationPerspective
working area
.
isWorkingArea
in interface CStationPerspective
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |