com.vlsolutions.swing.docking
Class AutoHidePolicy

java.lang.Object
  extended by com.vlsolutions.swing.docking.AutoHidePolicy

public class AutoHidePolicy
extends java.lang.Object

This class holds preferences on default autohiding behaviour.

See Also:
AutoHideButtonPanel

Field Summary
static int EXPAND_ON_CLICK
          A constant for expanding a button on click
static int EXPAND_ON_ROLLOVER
          A constant for expanding a button on rollover
static java.lang.String PROPERTY_DEFAULT_GAP
          a constant designing the bound property DEFAULT_GAP
static java.lang.String PROPERTY_DEFAULT_HIDE_BORDER
          a constant designing the bound property DEFAULT_HIDE_BORDER
static java.lang.String PROPERTY_EXPAND_MODE
          a constant designing the bound property EXPAND_MODE
static java.lang.String PROPERTY_EXPANSION_DURATION
          a constant designing the bound property EXPANSION_DURATION
static java.lang.String PROPERTY_ROLLOVER_TRIGGER_DELAY
          a constant designing the bound property ROLLOVER_TRIGGER_DELAY
 
Method Summary
 void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
          Hook for property change notification
 void addPropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)
          Hook for property change notification
 int getDefaultGap()
          Returns the default gap between border components
 DockingConstants.Hide getDefaultHideBorder()
          Returns the default hide border (used when not specified in a DockKey)
 int getExpandMode()
          Returns the expand mode in use.
 int getExpansionDuration()
          Returns the expansion duration (in millis)
static AutoHidePolicy getPolicy()
          Returns the singleton instance of this class
 int getRolloverTriggerDelay()
          Returns the rollover trigger delay (in millis)
 void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
          Remove a property change notification
 void removePropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)
          Remove a property change notification
 void setDefaultGap(int gap)
          Updates the gap (in pixels) between auto-hide buttons
 void setDefaultHideBorder(DockingConstants.Hide defaultHideBorder)
          Updates the default hide border.
 void setExpandMode(int expandMode)
          Updates the expand mode.
 void setExpansionDuration(int millis)
          Updates the expansion duration (time in millis)
 void setRolloverTriggerDelay(int delay)
          Updates the rollover trigger delay
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

EXPAND_ON_ROLLOVER

public static final int EXPAND_ON_ROLLOVER
A constant for expanding a button on rollover

See Also:
Constant Field Values

EXPAND_ON_CLICK

public static final int EXPAND_ON_CLICK
A constant for expanding a button on click

See Also:
Constant Field Values

PROPERTY_DEFAULT_HIDE_BORDER

public static final java.lang.String PROPERTY_DEFAULT_HIDE_BORDER
a constant designing the bound property DEFAULT_HIDE_BORDER

See Also:
Constant Field Values

PROPERTY_DEFAULT_GAP

public static final java.lang.String PROPERTY_DEFAULT_GAP
a constant designing the bound property DEFAULT_GAP

See Also:
Constant Field Values

PROPERTY_EXPAND_MODE

public static final java.lang.String PROPERTY_EXPAND_MODE
a constant designing the bound property EXPAND_MODE

See Also:
Constant Field Values

PROPERTY_ROLLOVER_TRIGGER_DELAY

public static final java.lang.String PROPERTY_ROLLOVER_TRIGGER_DELAY
a constant designing the bound property ROLLOVER_TRIGGER_DELAY

See Also:
Constant Field Values

PROPERTY_EXPANSION_DURATION

public static final java.lang.String PROPERTY_EXPANSION_DURATION
a constant designing the bound property EXPANSION_DURATION

See Also:
Constant Field Values
Method Detail

setDefaultHideBorder

public void setDefaultHideBorder(DockingConstants.Hide defaultHideBorder)
Updates the default hide border.

Default is AutoHideExpandPanel.LEFT;

Parameters:
defaultHideBorder - values taken from DockingConstants.HIDE_TOP, HIDE_LEFT, HIDE_BOTTOM, HIDE_RIGHT

getDefaultHideBorder

public DockingConstants.Hide getDefaultHideBorder()
Returns the default hide border (used when not specified in a DockKey)


getDefaultGap

public int getDefaultGap()
Returns the default gap between border components


setDefaultGap

public void setDefaultGap(int gap)
Updates the gap (in pixels) between auto-hide buttons


getPolicy

public static AutoHidePolicy getPolicy()
Returns the singleton instance of this class


getExpandMode

public int getExpandMode()
Returns the expand mode in use.

Returns:
EXPAND_ON_ROLLOVER or EXPAND_ON_CLICK

setExpandMode

public void setExpandMode(int expandMode)
Updates the expand mode.

Parameters:
expandMode - legal values are EXPAND_ON_ROLLOVER or EXPAND_ON_CLICK

getRolloverTriggerDelay

public int getRolloverTriggerDelay()
Returns the rollover trigger delay (in millis)


setRolloverTriggerDelay

public void setRolloverTriggerDelay(int delay)
Updates the rollover trigger delay

Parameters:
delay - delay in millis before expanding a Dockable

getExpansionDuration

public int getExpansionDuration()
Returns the expansion duration (in millis)


setExpansionDuration

public void setExpansionDuration(int millis)
Updates the expansion duration (time in millis)


addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
Hook for property change notification


addPropertyChangeListener

public void addPropertyChangeListener(java.lang.String propertyName,
                                      java.beans.PropertyChangeListener listener)
Hook for property change notification


removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
Remove a property change notification


removePropertyChangeListener

public void removePropertyChangeListener(java.lang.String propertyName,
                                         java.beans.PropertyChangeListener listener)
Remove a property change notification



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