pub.vlsolutions.swing.docking

Class AutoHidePolicy

java.lang.Object

pub.vlsolutions.swing.docking.AutoHidePolicy

public class AutoHidePolicy
extends java.lang.Object

This class holds preferences on default autohiding behaviour.

Version:

1.0

Author:

Lilian Chamontin, vlsolutions.

See Also:

AutoHideButtonPanel

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AutoHidePolicy.ExpandMode A set of constants for expanding a button on rollover, or on click

Field Summary

Fields

Modifier and Type	Field and Description
static int	INITIAL_EXPAND_COMPONENT_SIZE A constant for initial expantion : based on preferred size of component
static int	INITIAL_EXPAND_CUSTOM_SIZE A constant for initial expantion : based on custom widths and heights
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 (enum type)
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

Methods

Modifier and Type	Method and Description
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)
AutoHidePolicy.ExpandMode	getExpandMode() Returns the expand mode in use.
int	getExpansionDuration() Returns the expansion duration (in millis)
int	getInitialExpansionHeight()
int	getInitialExpansionModel() returns the expansion model (computation size of first expansion)
int	getInitialExpansionWidth()
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(AutoHidePolicy.ExpandMode expandMode) Updates the expand mode.
void	setExpansionDuration(int millis) Updates the expansion duration (time in millis)
void	setInitialExpansionHeight(int initialExpansionHeight) sets the first expansion height (only used with INITIAL_EXPAND_CUSTOM_SIZE model)
void	setInitialExpansionModel(int model)
void	setInitialExpansionWidth(int initialExpansionWidth) sets the first expansion width (only used with INITIAL_EXPAND_CUSTOM_SIZE model)
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

INITIAL_EXPAND_COMPONENT_SIZE

public static final int INITIAL_EXPAND_COMPONENT_SIZE

A constant for initial expantion : based on preferred size of component

See Also:

setInitialExpansionModel(int), Constant Field Values

INITIAL_EXPAND_CUSTOM_SIZE

public static final int INITIAL_EXPAND_CUSTOM_SIZE

A constant for initial expantion : based on custom widths and heights

See Also:

setInitialExpansionWidth(int), setInitialExpansionHeight(int), setInitialExpansionModel(int), 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 (enum type)

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 AutoHidePolicy.ExpandMode getExpandMode()

Returns the expand mode in use.

Returns:

EXPAND_ON_ROLLOVER or EXPAND_ON_CLICK

setExpandMode

public void setExpandMode(AutoHidePolicy.ExpandMode 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

getInitialExpansionModel

public int getInitialExpansionModel()

returns the expansion model (computation size of first expansion)

Returns:

the useComponentPreferredSize

setInitialExpansionModel

public void setInitialExpansionModel(int model)

Parameters:

model - the model to set, values are INITIAL_EXPAND_CUSTOM_SIZE and INITIAL_EXPAND_COMPONENT_SIZE

getInitialExpansionWidth

public int getInitialExpansionWidth()

Returns:

the initialExpansionWidth

setInitialExpansionWidth

public void setInitialExpansionWidth(int initialExpansionWidth)

sets the first expansion width (only used with INITIAL_EXPAND_CUSTOM_SIZE model)

Parameters:

initialExpansionWidth - the with to set for first expansion

See Also:

setInitialExpansionModel(int)

getInitialExpansionHeight

public int getInitialExpansionHeight()

Returns:

the initialExpansionHeight

setInitialExpansionHeight

public void setInitialExpansionHeight(int initialExpansionHeight)

sets the first expansion height (only used with INITIAL_EXPAND_CUSTOM_SIZE model)

Parameters:

initialExpansionHeight - the initialExpansionHeight to set

See Also:

setInitialExpansionModel(int)