|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JPanel
org.flexdock.docking.defaults.DefaultDockingPort
org.flexdock.view.Viewport
public class Viewport
Nested Class Summary |
---|
Nested classes/interfaces inherited from class org.flexdock.docking.defaults.DefaultDockingPort |
---|
DefaultDockingPort.PortLayout |
Nested classes/interfaces inherited from class javax.swing.JPanel |
---|
JPanel.AccessibleJPanel |
Nested classes/interfaces inherited from class javax.swing.JComponent |
---|
JComponent.AccessibleJComponent |
Nested classes/interfaces inherited from class java.awt.Container |
---|
Container.AccessibleAWTContainer |
Nested classes/interfaces inherited from class java.awt.Component |
---|
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy |
Nested classes/interfaces inherited from interface org.flexdock.docking.event.DockingListener |
---|
DockingListener.Stub |
Field Summary | |
---|---|
protected HashSet |
blockedRegions
|
Fields inherited from class org.flexdock.docking.defaults.DefaultDockingPort |
---|
dockingListeners |
Fields inherited from class javax.swing.JComponent |
---|
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW |
Fields inherited from class java.awt.Component |
---|
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT |
Fields inherited from interface org.flexdock.docking.DockingConstants |
---|
ACTIVE_WINDOW, BOTTOM, CENTER, CENTER_REGION, CLOSE_ACTION, DEFAULT_PERSISTENCE_KEY, DOCKING_ID, EAST_REGION, HEAVYWEIGHT_DOCKABLES, HORIZONTAL, LEFT, MOUSE_PRESSED, NORTH_REGION, PERMANENT_FOCUS_OWNER, PIN_ACTION, REGION, RIGHT, SOUTH_REGION, TOP, UNINITIALIZED, UNINITIALIZED_RATIO, UNKNOWN_REGION, UNSPECIFIED_SIBLING_PREF, VERTICAL, WEST_REGION |
Fields inherited from interface org.flexdock.docking.DockingPort |
---|
INITIAL_TAB_POSITION |
Fields inherited from interface java.awt.image.ImageObserver |
---|
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH |
Constructor Summary | |
---|---|
Viewport()
|
|
Viewport(String portId)
|
Method Summary | |
---|---|
protected JTabbedPane |
createTabbedPane()
If this method returns null , implementations may throw
NullPointerExceptions. |
boolean |
dock(Dockable dockable)
|
Set |
getViewset()
|
Set |
getViewset(int depth)
|
boolean |
isDockingAllowed(Component comp,
String region)
Returns true if docking is allowed for the specified
Component within the supplied region , false
otherwise. |
protected String |
paramString()
|
void |
setRegionBlocked(String region,
boolean isBlocked)
|
Methods inherited from class javax.swing.JPanel |
---|
getAccessibleContext, getUI, getUIClassID, setUI, updateUI |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.flexdock.docking.DockingPort |
---|
getClientProperty, putClientProperty |
Field Detail |
---|
protected HashSet blockedRegions
Constructor Detail |
---|
public Viewport()
public Viewport(String portId)
Method Detail |
---|
public void setRegionBlocked(String region, boolean isBlocked)
public boolean isDockingAllowed(Component comp, String region)
DefaultDockingPort
true
if docking is allowed for the specified
Component
within the supplied region
, false
otherwise. It is important to note that success of a docking operation
relies on many factors and a return value of true
from this
method does not necessarily guarantee that a call to dock()
will
succeed. This method merely indicates that the current
DockingPort
does not have any outstanding reason to block a
docking operation with respect to the specified Component
and
region
.
If comp
is null
or region
is invalid according to
DockingManager.isValidDockingRegion(String region)
, then this
method returns false
.
If this DockingPort
is not already the parent DockingPort
for the specified Component
, then this method returns
true
.
If this DockingPort
is already the parent DockingPort
for
the specified Component
, then a check is performed to see if
there is a tabbed layout. Tabbed layouts may contain multiple
Dockables
, and thus the tab ordering may be rearranged, or
shifted into a split layout. If comp
is the only docked
Component
within this DockingPort
, then this method
returns false
since the layout cannot be rearranged. Otherwise,
this method returns true
.
isDockingAllowed
in interface DockingPort
isDockingAllowed
in class DefaultDockingPort
comp
- the Component
whose docking availability is to be
checkedregion
- the region to be checked for docking availability for the
specified Component
.
true
if docking is allowed for the specified
Component
within the supplied region
,
false
otherwise.DockingPort.isDockingAllowed(Component, String)
,
DockingManager.isValidDockingRegion(String)
,
DefaultDockingPort.isParentDockingPort(Component)
public boolean dock(Dockable dockable)
protected JTabbedPane createTabbedPane()
DefaultDockingPort
null
, implementations may throw
NullPointerExceptions. Do not expect NPE checking.
createTabbedPane
in class DefaultDockingPort
public Set getViewset()
public Set getViewset(int depth)
protected String paramString()
paramString
in class JPanel
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |