com.vlsolutions.swing.docking

Class AutoHidePolicy

public class AutoHidePolicy extends Object

This class holds preferences on default autohiding behaviour.

See Also:

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 String	PROPERTY_DEFAULT_GAP a constant designing the bound property DEFAULT_GAP
static String	PROPERTY_DEFAULT_HIDE_BORDER a constant designing the bound property DEFAULT_HIDE_BORDER
static String	PROPERTY_EXPAND_MODE a constant designing the bound property EXPAND_MODE
static String	PROPERTY_EXPANSION_DURATION a constant designing the bound property EXPANSION_DURATION
static String	PROPERTY_ROLLOVER_TRIGGER_DELAY a constant designing the bound property ROLLOVER_TRIGGER_DELAY

Method Summary
void	addPropertyChangeListener(PropertyChangeListener listener) Hook for property change notification
void	addPropertyChangeListener(String propertyName, 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(PropertyChangeListener listener) Remove a property change notification
void	removePropertyChangeListener(String propertyName, 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

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