dundas.view.controls.BasicAdapter Class

 

Inheritance Hierarchy

 
Class
   dundas.Component
      dundas.view.controls.BasicAdapter
         dundas.view.controls.Adapter
         dundas.view.controls.CanvasAdapter
         dundas.view.controls.Layer
         dundas.view.controls.TemplateCell
 

Constructors

 
  Name Description
init Initializes the Adapter. Called during construction.
 
 

Properties

 
  Name Description
baseViewService Gets the base view service. This might be a dundas.views.BaseViewViewService or derivation thereof if this adapter is on a View entity. A way to check is to duck-type for .currentView.
container Gets or sets the container DIV element which holds the DOM control element.
friendlyName Gets or sets the friendly name for this adapter which is the name shown to the end user.
height Gets or sets the height value.
id Gets or sets the ID for this adapter (constant, unique).
isDisposed Gets a value indicating whether this instance has been disposed. Inherited from dundas.Component.
isInTemplate Gets or sets if this adapter is part of a canvas template.
isSimplePropertyPanelOpen Gets a value indicating whether the simple property panel is open or not.
layerId Gets or sets the ID of the layer that this adapter belongs to.
left Gets or sets the left value.
locked Gets or sets a value indicating whether this adapter is locked.
name Gets or sets the name for this adapter to be used in script. This name may change, but must be unique.
site Gets or sets the site that this component is a part of. Inherited from dundas.Component.
top Gets or sets the top value.
uniqueId Gets or sets the unique ID of this component within the site. Inherited from dundas.Component.
width Gets or sets the width value.
 
 

Methods

 
  Name Description
attach Attaches the container of this adapter to the target element.
createDelegate Helper for creating delegate functions. Inherited from dundas.Component.
createTimeout Creates a timeout. Inherited from dundas.Component.
dispatch Dispatches a call by creating a delegate and running it right away on a timer. Inherited from dundas.Component.
dispose This must be called when the adapter is being removed from the screen to avoid leaks. Inherited from dundas.Component.
fromJObject Applies the property values from a plain object created from JSON to the properties of this instance. Inherited from Class.
getBoundVisuals Gets the available bound visuals for a given metric set binding.
getContext Gets the context from the adapter based on the given information. This context can be used to provide contextual toolbar and property grid experiences.
getContextualCommands Gets the contextual toolbar commands.
getControlProperties Called to get the object with the list of properties on the root control, or any sub-element of the control.
getService Gets the requested service. Inherited from dundas.Component.
getSupportedSettings Gets the settings for the supported operations of this adapter. Implementers of this function should call this._super() first to get the default settings.
hideSimplePropertyPanel Hides the simple property panel.
onDOMDetach Called when the adapter is detached from the DOM.
onDOMReattach Called when the adapter is reattached to the DOM.
onLoaded Called when the adapter is loaded and set up. The control should be set up by the adapter now and added to the container element. Implementers of this method must call this._super() at the end if they want actions and events to be automatically set up.
onPropertyChanged Called when a property is changed on the adapter. This will not be called during a bulk change, as those properties are set via direct sets to avoid this event firing.
refreshPropertyGridWithContext Refresh property grid, if necessary, while keeping the last known context and state of the property grid.
showSimplePropertyPanel Shows the simple properties panel.
subscribeDisposedEvent Subscribe a handler for the disposed event.
suppressNextPropertyChangedEvent Prevents property changed event to be fired next time a property is set.
tempDetach Temporarily detaches the container of the adapter off the DOM, all events are retained.
toJSON Implementation for toJSON to return an object that will include this class's prototype property values when stringified. Inherited from Class.