Class YAHOO.ext.SplitBar
Creates draggable splitter bar functionality from two elements.
Usage:
var split = new YAHOO.ext.SplitBar('elementToDrag', 'elementToSize',
YAHOO.ext.SplitBar.HORIZONTAL, YAHOO.ext.SplitBar.LEFT);
split.setAdapter(new YAHOO.ext.SplitBar.AbsoluteLayoutAdapter("container"));
split.minSize = 100;
split.maxSize = 600;
split.animate = true;
split.onMoved.subscribe(splitterMoved);
Public Properties
|
animate : Boolean |
SplitBar |
Whether to animate the transition to the new size |
|
maxSize : Number |
SplitBar |
The maximum size of the resizing element. (Defaults to 2000) |
|
minSize : Number |
SplitBar |
The minimum size of the resizing element. (Defaults to 0) |
|
useShim : Boolean |
SplitBar |
Whether to create a transparent shim that overlays the page when dragging, enables dragging across iframes. |
Public Methods
|
SplitBar(String/HTMLElement/Element dragElement , String/HTMLElement/Element resizingElement , [Number orientation ], [Number placement ]) |
SplitBar |
Create a new SplitBar |
|
addListener(String eventName , Function handler , [Object scope ], [boolean override ]) : void |
Observable |
Appends an event handler to this element |
|
delayedListener(String eventName , Function handler , [Object scope ], [Number delay ]) : Function |
Observable |
Appends an event handler to this element that is delayed the specified number of milliseconds. |
|
fireEvent(String eventName , Object... args ) : void |
Observable |
Fires the specified event with the passed parameters (minus the event name). |
|
getAdapter() : The |
SplitBar |
Get the adapter this SplitBar uses |
|
getMaximumSize() : Number |
SplitBar |
Gets the maximum size for the resizing element |
|
getMinimumSize() : Number |
SplitBar |
Gets the minimum size for the resizing element |
|
purgeListeners() : void |
Observable |
Removes all listeners for this object |
|
removeListener(String eventName , Function handler , [Object scope ]) : void |
Observable |
Removes a listener |
|
setAdapter(Object adapter ) : void |
SplitBar |
Set the adapter this SplitBar uses |
|
setCurrentSize(Number size ) : void |
SplitBar |
Sets the initialize size for the resizing element |
|
setMaximumSize(Number maxSize ) : void |
SplitBar |
Sets the maximum size for the resizing element |
|
setMinimumSize(Number minSize ) : void |
SplitBar |
Sets the minimum size for the resizing element |
Public Events
|
beforeresize : (YAHOO.ext.SplitBar this ) |
SplitBar |
Fires before the splitter is dragged |
|
moved : (YAHOO.ext.SplitBar this , Number newSize ) |
SplitBar |
Fires when the splitter is moved |
|
resize : (YAHOO.ext.SplitBar this , Number newSize ) |
SplitBar |
Fires when the splitter is moved (alias for moved) |
Property Details
animate
public Boolean animate
Whether to animate the transition to the new size
This property is defined by SplitBar.
maxSize
public Number maxSize
The maximum size of the resizing element. (Defaults to 2000)
This property is defined by SplitBar.
minSize
public Number minSize
The minimum size of the resizing element. (Defaults to 0)
This property is defined by SplitBar.
useShim
public Boolean useShim
Whether to create a transparent shim that overlays the page when dragging, enables dragging across iframes.
This property is defined by SplitBar.
Constructor Details
SplitBar
public function SplitBar(String/HTMLElement/Element dragElement
, String/HTMLElement/Element resizingElement
, [Number orientation
], [Number placement
])
Create a new SplitBar
Parameters:
dragElement
: String/HTMLElement/ElementThe element to be dragged and act as the SplitBar.
resizingElement
: String/HTMLElement/ElementThe element to be resized based on where the SplitBar element is dragged
orientation
: Number(optional) Either YAHOO.ext.SplitBar.HORIZONTAL or YAHOO.ext.SplitBar.VERTICAL. (Defaults to HORIZONTAL)
placement
: Number(optional) Either YAHOO.ext.SplitBar.LEFT or YAHOO.ext.SplitBar.RIGHT for horizontal or YAHOO.ext.SplitBar.TOP or YAHOO.ext.SplitBar.BOTTOM for vertical. (By default, this is determined automatically by the intial position position of the SplitBar).
Method Details
addListener
public function addListener(String eventName
, Function handler
, [Object scope
], [boolean override
])
Appends an event handler to this element
Parameters:
eventName
: StringThe type of event to listen for
handler
: FunctionThe method the event invokes
scope
: Object(optional) The scope (this object) for the handler
override
: boolean(optional) If true, scope becomes the scope
Returns:
delayedListener
public function delayedListener(String eventName
, Function handler
, [Object scope
], [Number delay
])
Appends an event handler to this element that is delayed the specified number of milliseconds.
Parameters:
eventName
: StringThe type of event to listen for
handler
: FunctionThe method the event invokes
scope
: Object(optional) The scope (this object) for the handler
delay
: Number(optional) The number of milliseconds to delay
Returns:
fireEvent
public function fireEvent(String eventName
, Object... args
)
Fires the specified event with the passed parameters (minus the event name).
getAdapter
public function getAdapter()
Get the adapter this SplitBar uses
This method is defined by SplitBar.
getMaximumSize
public function getMaximumSize()
Gets the maximum size for the resizing element
This method is defined by SplitBar.
getMinimumSize
public function getMinimumSize()
Gets the minimum size for the resizing element
This method is defined by SplitBar.
purgeListeners
public function purgeListeners()
Removes all listeners for this object
removeListener
public function removeListener(String eventName
, Function handler
, [Object scope
])
setAdapter
public function setAdapter(Object adapter
)
Set the adapter this SplitBar uses
This method is defined by SplitBar.
setCurrentSize
public function setCurrentSize(Number size
)
Sets the initialize size for the resizing element
Parameters:
size
: NumberThe initial size
Returns:
This method is defined by SplitBar.
setMaximumSize
public function setMaximumSize(Number maxSize
)
Sets the maximum size for the resizing element
Parameters:
maxSize
: NumberThe maximum size
Returns:
This method is defined by SplitBar.
setMinimumSize
public function setMinimumSize(Number minSize
)
Sets the minimum size for the resizing element
Parameters:
minSize
: NumberThe minimum size
Returns:
This method is defined by SplitBar.
Event Details
beforeresize
public event beforeresize
Fires before the splitter is dragged
Subscribers will be called with the following parameters:
this
: YAHOO.ext.SplitBar
This event is defined by SplitBar.
moved
public event moved
Fires when the splitter is moved
Subscribers will be called with the following parameters:
this
: YAHOO.ext.SplitBarnewSize
: Numberthe new width or height
This event is defined by SplitBar.
resize
public event resize
Fires when the splitter is moved (alias for moved)
Subscribers will be called with the following parameters:
this
: YAHOO.ext.SplitBarnewSize
: Numberthe new width or height
This event is defined by SplitBar.