net.infonode.docking.properties

Class DockingWindowDropFilterProperties

public class DockingWindowDropFilterProperties extends PropertyMapContainer

Properties and property values for DropFilters for all types of DockingWindows.

Since: IDW 1.4.0

Version: $Revision: 1.4 $

Author: $Author: jesper $

Field Summary
static DropFilterProperty	CHILD_DROP_FILTER The DropFilter that is called when a child window will be asked for accept drop.
static DropFilterProperty	INSERT_TAB_DROP_FILTER The DropFilter that is called when an insert tab drop is in progress.
static DropFilterProperty	INTERIOR_DROP_FILTER The DropFilter that is called when an interior drop is in progress.
static PropertyMapGroup	PROPERTIES Property group containing all docking window drop filter properties.
static DropFilterProperty	SPLIT_DROP_FILTER The DropFilter that is called when a split drop is in progress.

Constructor Summary
	DockingWindowDropFilterProperties() Creates an empty property object.
	DockingWindowDropFilterProperties(PropertyMap map) Creates a property object containing the map.
	DockingWindowDropFilterProperties(DockingWindowDropFilterProperties inheritFrom) Creates a property object that inherit values from another property object.

Method Summary
DockingWindowDropFilterProperties	addSuperObject(DockingWindowDropFilterProperties properties) Adds a super object from which property values are inherited.
DropFilter	getChildDropFilter() Returns the child drop filter that is used when a child window will be asked for accept drop.
DropFilter	getInsertTabDropFilter() Returns the insert tab drop filter that is used when an insert tab drop is in progress.
DropFilter	getInteriorDropFilter() Returns the interior drop filter that is used when an interior drop is in progress.
DropFilter	getSplitDropFilter() Returns the split drop filter that is used when a split drop is in progress.
DockingWindowDropFilterProperties	removeSuperObject(DockingWindowDropFilterProperties superObject) Removes a super object.
DockingWindowDropFilterProperties	setChildDropFilter(DropFilter filter) Sets the child drop filter to be used when a child window will be asked for accept drop.
DockingWindowDropFilterProperties	setInsertTabDropFilter(DropFilter filter) Sets the insert tab drop filter to be used when an insert tab drop is in progress.
DockingWindowDropFilterProperties	setInteriorDropFilter(DropFilter filter) Sets the interior drop filter to be used when an interior drop is in progress.
DockingWindowDropFilterProperties	setSplitDropFilter(DropFilter filter) Sets the split drop filter to be used when a split drop is in progress.

Field Detail

CHILD_DROP_FILTER

public static final DropFilterProperty CHILD_DROP_FILTER

The DropFilter that is called when a child window will be asked for accept drop.

INSERT_TAB_DROP_FILTER

public static final DropFilterProperty INSERT_TAB_DROP_FILTER

The DropFilter that is called when an insert tab drop is in progress.

INTERIOR_DROP_FILTER

public static final DropFilterProperty INTERIOR_DROP_FILTER

The DropFilter that is called when an interior drop is in progress.

PROPERTIES

public static final PropertyMapGroup PROPERTIES

Property group containing all docking window drop filter properties.

SPLIT_DROP_FILTER

public static final DropFilterProperty SPLIT_DROP_FILTER

The DropFilter that is called when a split drop is in progress.

Constructor Detail

DockingWindowDropFilterProperties

public DockingWindowDropFilterProperties()

Creates an empty property object.

DockingWindowDropFilterProperties

public DockingWindowDropFilterProperties(PropertyMap map)

Creates a property object containing the map.

Parameters: map the property map

DockingWindowDropFilterProperties

public DockingWindowDropFilterProperties(DockingWindowDropFilterProperties inheritFrom)

Creates a property object that inherit values from another property object.

Parameters: inheritFrom the object from which to inherit property values

Method Detail

addSuperObject

public DockingWindowDropFilterProperties addSuperObject(DockingWindowDropFilterProperties properties)

Adds a super object from which property values are inherited.

Parameters: properties the object from which to inherit property values

Returns: this

getChildDropFilter

public DropFilter getChildDropFilter()

Returns the child drop filter that is used when a child window will be asked for accept drop.

Returns: the child drop filter

getInsertTabDropFilter

public DropFilter getInsertTabDropFilter()

Returns the insert tab drop filter that is used when an insert tab drop is in progress.

Returns: the child drop filter

getInteriorDropFilter

public DropFilter getInteriorDropFilter()

Returns the interior drop filter that is used when an interior drop is in progress.

Returns: the interior drop filter

getSplitDropFilter

public DropFilter getSplitDropFilter()

Returns the split drop filter that is used when a split drop is in progress.

Returns: the split drop filter

removeSuperObject

public DockingWindowDropFilterProperties removeSuperObject(DockingWindowDropFilterProperties superObject)

Removes a super object.

Parameters: superObject the super object to remove

Returns: this

setChildDropFilter

public DockingWindowDropFilterProperties setChildDropFilter(DropFilter filter)

Sets the child drop filter to be used when a child window will be asked for accept drop.

Parameters: filter the child drop filter

Returns: this

setInsertTabDropFilter

public DockingWindowDropFilterProperties setInsertTabDropFilter(DropFilter filter)

Sets the insert tab drop filter to be used when an insert tab drop is in progress.

Parameters: filter the insert tab drop filter

Returns: this

setInteriorDropFilter

public DockingWindowDropFilterProperties setInteriorDropFilter(DropFilter filter)

Sets the interior drop filter to be used when an interior drop is in progress.

Parameters: filter the interior drop filter

Returns: this

setSplitDropFilter

public DockingWindowDropFilterProperties setSplitDropFilter(DropFilter filter)

Sets the split drop filter to be used when a split drop is in progress.

Parameters: filter the split drop filter

Returns: this