Prototype-UI

Release Candidate 0

Shadow

Window

WindowManager

UI. Shadow

Add shadow around a DOM element. The element MUST BE in ABSOLUTE position.

Shadow can be skinned by CSS (see mac_shadow.css or drop_shadow.css). CSS must be included to see shadow.

A shadow can have two states: focused and blur. Shadow shifts are set in CSS file as margin and padding of shadow_container to add visual information.

Example

new UI.Shadow("element_id");

Summary

UI. Shadow	Add shadow around a DOM element.
initialize	Constructor, adds shadow elements to the DOM if element is in the DOM.
destroy	Destructor, removes elements from the DOM
Size and Position
setPosition	Sets top/left shadow position in pixels
setSize	Sets width/height shadow in pixels
setBounds	Sets shadow bounds in pixels
setZIndex	Sets shadow z-index
Render
show	Displays shadow
hide	Hides shadow
remove	Removes shadow from the DOM
Status
focus	Focus shadow.
blur	Blurs shadow.

initialize

initialize: function( element,
options )

Constructor, adds shadow elements to the DOM if element is in the DOM. Element MUST BE in ABSOLUTE position.

Parameters

element	DOM element
options	Hashmap of options

theme (default: mac_shadow)
focus (default: true)
zIndex (default: 100)

Returns

this

destroy

destroy: function()

Destructor, removes elements from the DOM

Size and Position

setPosition

setPosition: function( top,
left )

Sets top/left shadow position in pixels

Parameters

top	top position in pixel
left	left position in pixel

Returns

this

setSize

setSize: function( width,
height )

Sets width/height shadow in pixels

Parameters

width	width in pixel
height	height in pixel

Returns

this

setBounds

setBounds: function( bounds )

Sets shadow bounds in pixels

Parameters

bounds

an Hash {top:, left:, width:, height:}

Returns

this

setZIndex

setZIndex: function( zIndex )

Sets shadow z-index

Parameters

zIndex

zIndex value

Returns

this

Render

show

show: function()

Displays shadow

Returns

this

hide

hide: function()

Hides shadow

Returns

this

remove

remove: function()

Removes shadow from the DOM

Returns

this

Status

focus

focus: function()

Focus shadow.

Change shadow shift. Shift values are set in CSS file as margin and padding of shadow_container to add visual information of shadow status.

Returns

this

blur

blur: function()

Blurs shadow.

Change shadow shift. Shift values are set in CSS file as margin and padding of shadow_container to add visual information of shadow status.

Returns

this

initialize: function( element,
options )

Constructor, adds shadow elements to the DOM if element is in the DOM.

destroy: function()

Destructor, removes elements from the DOM

setPosition: function( top,
left )

Sets top/left shadow position in pixels

setSize: function( width,
height )

Sets width/height shadow in pixels

setBounds: function( bounds )

Sets shadow bounds in pixels

setZIndex: function( zIndex )

Sets shadow z-index

show: function()

Displays shadow

hide: function()

Hides shadow

remove: function()

Removes shadow from the DOM

focus: function()

Focus shadow.

blur: function()

Blurs shadow.