com.vlsolutions.swing.docking

Class AutoHidePolicy

public class AutoHidePolicy extends Object

This class holds preferences on default autohiding behaviour.

See Also:

Field Summary
static intEXPAND_ON_CLICK
A constant for expanding a button on click
static intEXPAND_ON_ROLLOVER
A constant for expanding a button on rollover
static StringPROPERTY_DEFAULT_GAP
a constant designing the bound property DEFAULT_GAP
static StringPROPERTY_DEFAULT_HIDE_BORDER
a constant designing the bound property DEFAULT_HIDE_BORDER
static StringPROPERTY_EXPAND_MODE
a constant designing the bound property EXPAND_MODE
static StringPROPERTY_EXPANSION_DURATION
a constant designing the bound property EXPANSION_DURATION
static StringPROPERTY_ROLLOVER_TRIGGER_DELAY
a constant designing the bound property ROLLOVER_TRIGGER_DELAY
Method Summary
voidaddPropertyChangeListener(PropertyChangeListener listener)
Hook for property change notification
voidaddPropertyChangeListener(String propertyName, PropertyChangeListener listener)
Hook for property change notification
intgetDefaultGap()
Returns the default gap between border components
DockingConstants.HidegetDefaultHideBorder()
Returns the default hide border (used when not specified in a DockKey)
intgetExpandMode()
Returns the expand mode in use.
intgetExpansionDuration()
Returns the expansion duration (in millis)
static AutoHidePolicygetPolicy()
Returns the singleton instance of this class
intgetRolloverTriggerDelay()
Returns the rollover trigger delay (in millis)
voidremovePropertyChangeListener(PropertyChangeListener listener)
Remove a property change notification
voidremovePropertyChangeListener(String propertyName, PropertyChangeListener listener)
Remove a property change notification
voidsetDefaultGap(int gap)
Updates the gap (in pixels) between auto-hide buttons
voidsetDefaultHideBorder(DockingConstants.Hide defaultHideBorder)
Updates the default hide border.
voidsetExpandMode(int expandMode)
Updates the expand mode.
voidsetExpansionDuration(int millis)
Updates the expansion duration (time in millis)
voidsetRolloverTriggerDelay(int delay)
Updates the rollover trigger delay

Field Detail

EXPAND_ON_CLICK

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

EXPAND_ON_ROLLOVER

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

PROPERTY_DEFAULT_GAP

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

PROPERTY_DEFAULT_HIDE_BORDER

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

PROPERTY_EXPAND_MODE

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

PROPERTY_EXPANSION_DURATION

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

PROPERTY_ROLLOVER_TRIGGER_DELAY

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

Method Detail

addPropertyChangeListener

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

addPropertyChangeListener

public void addPropertyChangeListener(String propertyName, PropertyChangeListener listener)
Hook for property change notification

getDefaultGap

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

getDefaultHideBorder

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

getExpandMode

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

Returns: EXPAND_ON_ROLLOVER or EXPAND_ON_CLICK

getExpansionDuration

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

getPolicy

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

getRolloverTriggerDelay

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

removePropertyChangeListener

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

removePropertyChangeListener

public void removePropertyChangeListener(String propertyName, PropertyChangeListener listener)
Remove a property change notification

setDefaultGap

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

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

setExpandMode

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

Parameters: expandMode legal values are EXPAND_ON_ROLLOVER or EXPAND_ON_CLICK

setExpansionDuration

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

setRolloverTriggerDelay

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

Parameters: delay delay in millis before expanding a Dockable

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