dundas.controls.Dockable Class

 

Inheritance Hierarchy

 
Class
   dundas.EventDisposable
      dundas.controls.FocusableControl
         dundas.controls.Dockable
 

Constructors

 
  Name Description
init Create a dockable item that can be docked to a dockable area.
 
 

Properties

 
  Name Description
attachedDockableArea Gets or sets the area this dockable is attached to.
caption Gets or sets the caption for this dockable.
contextIconUrl Gets the context icon url.
controlContainer Gets the container of this control. Inherited from dundas.controls.FocusableControl.
defaultDockableArea Gets or sets the default dockable area this dockable is attached to.
dockableType Gets the type of this dockable.
isDisabled Gets or sets whether or not this control is disabled. Inherited from dundas.controls.FocusableControl.
isDisposed Gets a value indicating whether this instance has been disposed. Inherited from dundas.EventDisposable.
isFocused Gets or sets the focused state of this control. Inherited from dundas.controls.FocusableControl.
isViewModeDisabled Gets if dockable is disabled in View mode.
jQControlContainer Gets the container of this control in JQuery object. Inherited from dundas.controls.FocusableControl.
parentFocusable Gets the focusable parent of this control. Inherited from dundas.controls.FocusableControl.
sortOrder Gets the dockable sort order.
tooltipText Gets or sets the tooltip text for this dockable.
uiCache Gets the UI cache table Inherited from dundas.EventDisposable.
visualState Gets the visual state of the dockable.
 
 

Methods

 
  Name Description
attach Attaches this dockable with the given options.
bind Bind an event to this class object. Inherited from dundas.EventDisposable.
collapse Collapse this dockable.
detachToPopup Detaches this dockable try a popup.
dispose Performs tasks associated with releasing resources from this object once it is unneeded. Inherited from dundas.EventDisposable.
expand Expand this dockable.
focus Put this control into focus. Inherited from dundas.controls.FocusableControl.
fromJObject Applies the property values from a plain object created from JSON to the properties of this instance. Inherited from Class.
getContainer Get the container of this dockable.
getContentContainer Get the content container of this dockable.
getContextState Set the UI context state to be saved in dundas.UIContextFocus Inherited from dundas.controls.FocusableControl.
getIconContainer Get the (taskbar) icon container of this dockable.
hideFromDesigner Completely hides this dockable from the designer.
minimize Minimize this dockable.
raiseBindEvent Fire the event specified with eventName, or subscribe a handler. Inherited from dundas.EventDisposable.
redrawTab Redraws tab with orientation-appropriate output. (Toggle between vertical/horizontal)
select Select this dockable.
setContextState Restore this control to the state as defined. Inherited from dundas.controls.FocusableControl.
subscribe Subscribe or unsubscribe an event handler for an event. Inherited from dundas.EventDisposable.
subscribeBlurred Inherited from dundas.controls.FocusableControl.
subscribeDisposed Subscribe to the disposed event. Inherited from dundas.EventDisposable.
subscribeFocused Inherited from dundas.controls.FocusableControl.
subscribeOnce Subscribe a one time event handler for an event. Inherited from dundas.EventDisposable.
subscribeOptionsHandlers
subscribeVisibleStateChanged Fire the visualStateChanged event if callback is not specified. Subscribe handler if callback is specified.
toggleExpand Toggle Expanded/Collapsed state.
toJSON Implementation for toJSON to return an object that will include this class's prototype property values when stringified. Inherited from Class.
trigger Raise an event. Inherited from dundas.EventDisposable.
unbind Unsubscribe an event. if handler is specified, unsubscribe that handler. if no parameters are specified, unbind everything. Inherited from dundas.EventDisposable.
unbindAll unsubscribe all events. Inherited from dundas.EventDisposable.