PopupControl

A control for popping up a dialog box.

Remarks

Popup has a property, ID_item, which can be bound to an item to show in the popup.

Popups also define a template holding the contents of the popup.

Properties

ID_animators (inherited from Control)A SitedList of animators.
ID_childControls (inherited from ContainerControl)A SitedList of child controls.
ID_controlId (inherited from Control)The ID this control is known in the nearest binding container parent.
ID_eventMask (inherited from Control)(Advanced) A comma-separated list of peer events this control should receive.
ID_isBindingContainer (inherited from Control)(Advanced) Force this control to act as a binding container.
ID_isPeerless (inherited from Control)(Advanced) Set this to true to prevent this control from generating a peer element in the rendered HTML.
ID_itemThe item this Popup is associated with.
ID_placementHow the popup is positioned when shown.
ID_referenceControlThe controlId of a control to use when ID_placement is ID_dropDown.
ID_showingSet this to true to show the popup.
ID_submitters (inherited from Control)A SitedList of submitters.
ID_tagName (inherited from Control)Overrides the default HTML tag name used for this control.
ID_template
ID_visible (inherited from Control)True if this control is visible, false if it is hidden.

Events

ID_bound
ID_mouseDown (inherited from Control)Event handler called when a mouse button is pressed down.
ID_mouseMove (inherited from Control)Event handler called when the mouse is moved.
ID_mouseOut (inherited from Control)Event handler called when a leaves a control.
ID_mouseOver (inherited from Control)Event handler called when a mouse moves over a control.
ID_mouseUp (inherited from Control)Event handler called when a mouse button is released.
ID_unbound

Methods

acceptsDrop (inherited from Control)Called to determine if this control will accept a drop.
addBinding (inherited from Control)Adds a databinding between a property on this object and a binding path.
addBindingEx (inherited from Control)Extended entry point for adding a binding.
addCalculatedBinding (inherited from Control)Adds a calculated binding for a property.
addChild (inherited from ContainerControl)Add a child control to this ContainerControl.
addClassName (inherited from Control)Adds a CSS class to this controls "class" attribute
addEventHandler (inherited from SitedObject)Adds a delegate to be called when the specified eventId occurs on this object.
animateEx (inherited from Control)Animates a property to a value.
blur (inherited from Control)Tells this control's peer to relinquish keyboard focus.
bubble (inherited from Control)Bubbles a message up the control hierarchy - calls onBubbleEvent on this control and each of its parents.
captureMouse (inherited from Control)Register a control to receive mouse move/up events
construct (inherited from Control)Used to initialize a markup control.
equals (inherited from SitedObject)Tests if two objects are equal.
fireEventHandler (inherited from SitedObject)Invokes any user event handlers registered for a particular event using SitedObject.addEventHandler().
focus (inherited from Control)Tells this control's peer to request keyboard focus.
getBindingContainer (inherited from Control)Gets this object's nearest enclosing binding container.
getBindingStatus (inherited from SitedObject)Provides debugging information on bindings for this object.
getChild (inherited from ContainerControl)Gets the n'th child
getEventMask (inherited from Control)Gets an object indicating which peer events this control is interested in.
getParent (inherited from Control)Gets the parent Control of this control.
getPathValue (inherited from SitedObject)Traverses a binding path and returns the value at the end of it.
getPeer (inherited from Control)Gets the peer DOM element associated with this control.
getPeerForParent (inherited from Control)Gets the peer element of this control that the parent control should use in DOM manipulations.
getPropertyInfo (inherited from SitedObject)Gets information on a property.
getResource (inherited from Control)Given the ID of a resource, returns the resource's value.
getSite (inherited from SitedObject)Gets this object's site.
getTagName (inherited from ContainerControl)Gets the HTML tag name this control will use for its peer element.
getValue (inherited from Control)Gets a property, style or attribute.
getViewState (inherited from Control) Retrieve any viewstate that has been saved for this control in a previous session.
getViewStateId (inherited from Control) Get a unique and consistent viewstateId for this control.
invalidateLayout (inherited from Control)Tells the layout system to redo layout.
modifyDOM (inherited from ContainerControl)Called to manipulate the DOM peer node of this control.
onBubbleEvent (inherited from Control)Called to handle a bubbled event.
onDragEvent (inherited from Control)Called to handle a drag drop event..
onFirstRender (inherited from Control)Called the first time a control is rendered.
onPeerCreated (inherited from Control)Called when a peer is created.
onPeerEvent (inherited from Control)Called to dispatch low level events that arise in the Dom.
onSetValue (inherited from ContainerControl)Called by SitedObject.setValue() when a property value is set on this object.
onSited (inherited from SitedObject)Called when this object is sited.
onSitedRoot (inherited from Control)Called when a control is added to the main control tree.
onUnsited (inherited from SitedObject)Called when this object is about to lose its site.
onUnsitedRoot (inherited from Control)Called when a control is removed from the main control tree.
onValueSited (inherited from ContainerControl)Called when an object is sited within this object.
onValueUnsited (inherited from ContainerControl)Called when an object is about to be unsited in this.
onViewStateChanged (inherited from Control) Overridable. Controls implement this method to update their viewstate.
positionPopupPeerCalled to position a popup.
rebuildInnerHtml (inherited from ContainerControl)Updates this controls innerHTML.
reflectOnBoundValue (inherited from Control)Gets runtime reflection information on an underlying bound object.
removeChild (inherited from ContainerControl)Remove a child control from this ContainerControl.
removeClassName (inherited from Control)Removes a CSS class from this controls "class" attribute
removeEventHandler (inherited from SitedObject)Remove an existing delegate from the list of delegates for the specified event.
render (inherited from Control)Places the Html representation of this control into the htmlBuilder.
renderAttributes (inherited from Control)Called by Control.render() to render attributes for this control.
renderChildren (inherited from ContainerControl)Places the Html markup for all the Control inside this control into the htmlBuilder.
setBounds (inherited from Control)Convenience method to set the left/top/width/height of an element.
setInitialValues (inherited from SitedObject)Sets multiple property values on an object (during initialization only)
setPathValue (inherited from SitedObject)Traverses a binding path and sets the value at the end of it.
setValue (inherited from Control)Sets a property, style or attribute.
setViewState (inherited from Control) Save viewstate that should persist across sessions.
startAnimator (inherited from Control)Starts an animation.
startDragDrop (inherited from Control)Start a drag drop operation.
stopAnimator (inherited from Control)Stops an animation.
toString (inherited from SitedObject)Returns a string representation of this object.

PopupControl ID_bound event

JavaScript

popupControl.addEventHandler(ID_bound, new Delegate(obj, func))

Xml

<j:Popup bound="alert('bound happened')" ... >

PopupControl ID_item property

The item this Popup is associated with.

JavaScript

var obj = popupControl.getValue(ID_item)
popupControl.setValue(ID_item, obj)

Xml

<j:Popup>
  <j:item j:type="typeName">
    object
  <j:/item>
</j:Popup>

Example

This example binds the Popup ID_item property to myListControl.selectedItem, and then creates a text label showing the item's firstName: 

<j:Popup controlId="pop1" item="#bind(myListControl.selectedItem)">

	<!-- Now bind to "item" to show its details -->

	<j:Label text="#bind(item.firstName)"/>

	...

</j:Popup>

<j:Button text="Show popup" click="#bind(controls.pop1).show()"/>

PopupControl ID_placement property

How the popup is positioned when shown.

JavaScript

var idname = popupControl.getValue(ID_placement)
popupControl.setValue(ID_placement, idname)

Xml

<j:Popup placement="none"  ... >
or
<j:Popup placement="centered"  ... >
or
<j:Popup placement="dropDown"  ... >

Remarks

One of the following:

If ID_placement is ID_none, the popup is not positioned. It is up to the application to position the popup through a CSS stylesheet or by overriding PopupControl.positionPopupPeer().

If ID_placement is ID_centered, the popup is centered within the currently visible portion of the document.

If ID_placement is ID_dropDown, then the method looks at the control whose ID_controlId matches this control's ID_referenceControl - and position's the popup beneath that control, with the left edges aligned - similar to a dropdown menu. If there is no control with the specified referenceControl id, the popup is centered.

PopupControl ID_referenceControl property

The controlId of a control to use when ID_placement is ID_dropDown.

JavaScript

var strVal = popupControl.getValue(ID_referenceControl)
popupControl.setValue(ID_referenceControl, strVal)

Xml

<j:Popup referenceControl="string"  ... >

PopupControl ID_showing property

Set this to true to show the popup.

JavaScript

var boolVal = popupControl.getValue(ID_showing)
popupControl.setValue(ID_showing, boolVal)

Xml

<j:Popup showing="true"  ... >
or
<j:Popup showing="false"  ... >

PopupControl ID_template property

JavaScript

var template = popupControl.getValue(ID_template)
popupControl.setValue(ID_template, template)

Xml

<j:Popup>
  <j:template>
    Template
  <j:/template>
</j:Popup>

PopupControl ID_unbound event

JavaScript

popupControl.addEventHandler(ID_unbound, new Delegate(obj, func))

Xml

<j:Popup unbound="alert('unbound happened')" ... >

PopupControl positionPopupPeer method

Called to position a popup.

JavaScript

popupControl.positionPopupPeer(popupPeer)

Remarks

This is called after the popup's peer is created, the popup's contents have been rendered, but the popup is still invisible, (i.e. its style.visibility attribute is 'hidden').

The method decides how to position the popup on the screen by looking at the ID_placement property, as follows:

If ID_placement is ID_none, the popup is not positioned. It is up to the application to position the popup through a CSS stylesheet.

If ID_placement is ID_centered, the popup is centered within the currently visible portion of the document.

If ID_placement is ID_dropDown, then the method looks at the control whose ID_controlId matches the value of this control's ID_referenceControl - if a control is found, the popup is positioned beneath that control with the left edges aligned - similar to a dropdown menu.