biresizehandle.xml

来自「ajax 框价．是个好工具．javascript 矿家．可以用在任何平台．」· XML 代码 · 共 131 行

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="api.xsl"?>
<class name="BiResizeHandle" extends="BiComponent">
	<description>This component can be used to allow another component to be resizable
 using the mouse. The component can be used as a resize handle for the
 component to resize. It can also be used without adding it to another
 component by manually calling <link>startResize</link> in a mouse down
 event handler.</description>
	<arguments>
		<argument name="oHandleFor" optional="true">
			<description>The component that should be resizable. </description>
			<type>
				<link class="BiComponent">BiComponent</link>
			</type>
		</argument>
	</arguments>
	<staticMethods>
	</staticMethods>
	<staticFields>
	</staticFields>
	<methods>
		<method name="startResize">
			<description>Start the resizing of the component</description>
			<arguments>
				<argument name="sDir">
					<description>The direction that the resizing should be done in. Valid
 							values are:<br>
						</br>
						<br>
						</br>
                          s - south<br>
						</br>
                          n - north<br>
						</br>
                          e - east<br>
						</br>
                          w - west<br>
						</br>
                          se - south east<br>
						</br>
                          sw - south west<br>
						</br>
                          ne - north east<br>
						</br>
                          nw - north west</description>
					<type>String</type>
				</argument>
				<argument name="e">
					<description>The event object used to start the resizing using the mouse</description>
					<type>
						<link class="BiMouseEvent">BiMouseEvent</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
	</methods>
	<properties>
		<property name="handleFor" get="true" set="true">
			<description>The component that the handle should be a resize handle for.</description>
			<type>
				<link class="BiComponent">BiComponent</link>
			</type>
		</property>
		<property name="resizeDirection" get="true" set="true">
			<description>The direction that the resizing should be done in. Valid
 values are:<br>
				</br>
				<br>
				</br>
 s - south<br>
				</br>
 n - north<br>
				</br>
 e - east<br>
				</br>
 w - west<br>
				</br>
 se - south east<br>
				</br>
 sw - south west<br>
				</br>
 ne - north east<br>
				</br>
 nw - north west</description>
			<type>String</type>
		</property>
		<property name="resizing" get="true">
			<description>Whether the resize handle is currently actively resizing something</description>
			<type>Boolean</type>
		</property>
	</properties>
	<events>
		<event name="resize">
			<description>Fires continually during the resizing of the component</description>
			<type>
				<link class="BiResizeEvent">BiResizeEvent</link>
			</type>
		</event>
		<event name="beforeresize">
			<description>Fires continually during the resizing of the component. Call
 											<link class="BiEvent" field="preventDefault">preventDefault</link>
 											on the event object to prevent the new size from being applied.</description>
			<type>
				<link class="BiResizeEvent">BiResizeEvent</link>
			</type>
		</event>
		<event name="resizestart">
			<description>Fires once when the resizing begins. Call
 									<link class="BiEvent" field="preventDefault">preventDefault</link>
                                  on the event object to prevent the component from being resized.</description>
			<type>
				<link class="BiEvent">BiEvent</link>
			</type>
		</event>
		<event name="resizeend">
			<description>Fires when resizing of the component ends.</description>
			<type>
				<link class="BiEvent">BiEvent</link>
			</type>
		</event>
	</events>
	<remarks>When used in conjunction with <link>startResize</link> the component is
 			resized when the mouse is moved and the resizing ends when the mouse up
          event occurs. Therefore the logical place to call <link>startResize</link>
          is inside an event handler for a <link class="BiComponent" field="mousedown">mousedown</link>
          event.</remarks>
</class>