com.vlsolutions.swing.docking.event
Class DockingActionSplitComponentEvent

java.lang.Object
  extended by com.vlsolutions.swing.docking.event.DockingActionEvent
      extended by com.vlsolutions.swing.docking.event.DockingActionDockableEvent
          extended by com.vlsolutions.swing.docking.event.DockingActionSplitComponentEvent
All Implemented Interfaces:
java.lang.Cloneable

public class DockingActionSplitComponentEvent
extends DockingActionDockableEvent

A DockingActionEvent describing a split action (from a base component (splitcontainer, tab...)).

Since:
2.1

Field Summary
 
Fields inherited from class com.vlsolutions.swing.docking.event.DockingActionEvent
ACTION_ADD_DOCKABLE, ACTION_CLOSE, ACTION_CREATE_TAB, ACTION_SPLIT_COMPONENT, ACTION_SPLIT_DOCKABLE, ACTION_SPLIT_DOCKABLE_CONTAINER, ACTION_STATE_CHANGE
 
Constructor Summary
DockingActionSplitComponentEvent(DockingDesktop desktop, Dockable dockable, int initialState, int nextState, java.awt.Component base, DockingConstants.Split splitPosition, float dividorLocation)
          Constructs a new event
DockingActionSplitComponentEvent(DockingDesktop desktop, Dockable dockable, int initialState, int nextState, java.awt.Component base, DockingConstants.Split splitPosition, float dividorLocation, float parentDividorLocation)
          Constructs a new event.
 
Method Summary
 java.awt.Component getBase()
          Returns the dockable which will be used as a base for the splitting
 float getDividorLocation()
           
 float getParentDividorLocation()
          returns a dividor location value for the parent split container, or -1 if not needed
 DockingConstants.Split getSplitPosition()
           
 java.lang.String toString()
           
 
Methods inherited from class com.vlsolutions.swing.docking.event.DockingActionDockableEvent
getDockable, setDockable
 
Methods inherited from class com.vlsolutions.swing.docking.event.DockingActionEvent
clone, getActionType, getDesktop, getInitialDockableState, getNextDockableState
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DockingActionSplitComponentEvent

public DockingActionSplitComponentEvent(DockingDesktop desktop,
                                        Dockable dockable,
                                        int initialState,
                                        int nextState,
                                        java.awt.Component base,
                                        DockingConstants.Split splitPosition,
                                        float dividorLocation)
Constructs a new event


DockingActionSplitComponentEvent

public DockingActionSplitComponentEvent(DockingDesktop desktop,
                                        Dockable dockable,
                                        int initialState,
                                        int nextState,
                                        java.awt.Component base,
                                        DockingConstants.Split splitPosition,
                                        float dividorLocation,
                                        float parentDividorLocation)
Constructs a new event.

This version of the constructor also contains resizing information for the parent of thhe splitted component.

Method Detail

getBase

public java.awt.Component getBase()
Returns the dockable which will be used as a base for the splitting


getDividorLocation

public float getDividorLocation()

getParentDividorLocation

public float getParentDividorLocation()
returns a dividor location value for the parent split container, or -1 if not needed

This value is used to express inserting a component with same orientation of the parent split container (like : transform A|B into [A|child]|B : we need to adjust A|child dividor, and also [] | B dividor).


getSplitPosition

public DockingConstants.Split getSplitPosition()

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object


© Copyright 2004-2007 VLSolutions. All Rights Reserved.
www.vlsolutions.com : Java Components - Smart Client Applications