PREV CLASS    Documentation homepage     NEXT CLASS 

IlvEmptyView

IlvObject
  |
  +--IlvEmptyView
Category:
Common component
JavaScript File:
IlvEmptyView.js
Description:
IlvEmptyView is the base class of all views. It consists of an empty rectangular area that contains no child panels or subviews.

Constructor Summary
IlvEmptyView(left, top, width, height, namespace)

Method Summary
addSizeListener(listener)
Adds a listener to be called when the view is resized.
childrenToHTML()
Creates the HTML for this component's children.
getBounds()
Returns the bounds of this view.
getHeight()
Returns the height of this view.
getLeft()
Returns the left border of this view.
getLocation()
Returns the location of this view.
getSize()
Returns the size of this view.
getTop()
Returns the top border of this view.
getWidth()
Returns the width of this view.
isStateInCookie()
Returns whether the state of the view should be stored in a cookie or not.
removeSizeListener(listener)
Removes a listener installed with addSizeListener.
restoreState(view)
Handler called when the view should restore its state not from a cookie.
saveState(view)
Handler called when the view should save its state but not in a cookie.
setBounds(left, top, width, height)
Changes the size of the view.
setChildrenBounds(left, top, width, height)
Changes the size of this view's children.
setLocation(left, top)
Moves this view to the specified location.
setSize(width, height)
Sets the size of this view.
setStateInCookie(stateInCookie)
Sets whether the state of the view should be stored in a cookie or not.
toHTML()
Creates the HTML for this component.

Constructor Detail

IlvEmptyView

IlvEmptyView(left, top, width, height, namespace)
Creates an instance of IlvEmptyView.

Method Detail

addSizeListener

 
addSizeListener(listener)
Adds a listener to be called when the view is resized.
Parameters:
listener - The listener function, which must have the following parameter:
  1. view: The IlvEmptyView.

childrenToHTML

 
childrenToHTML()
Creates the HTML for this component's children. This implementation does nothing. Subclasses should override this method as needed. Warning: This method is considered to be part of an IlvEmptyView's internal implementation and is not a public API.

getBounds

 
getBounds()
Returns the bounds of this view.
Returns:
An object with four properties: left, top, width, and height. These properties represent the bounds of this view expressed in the coordinates of the browser window.

getHeight

 
getHeight()
Returns the height of this view.

getLeft

 
getLeft()
Returns the left border of this view.

getLocation

 
getLocation()
Returns the location of this view.
Returns:
An object with two properties: left and top. These properties represent the location of this view expressed in the coordinates of the browser window.

getSize

 
getSize()
Returns the size of this view.
Returns:
An object with two properties: width and height. These properties represent the size of this view expressed in pixels.

getTop

 
getTop()
Returns the top border of this view.

getWidth

 
getWidth()
Returns the width of this view.

isStateInCookie

 
isStateInCookie()
Returns whether the state of the view should be stored in a cookie or not. The default value is 'true'.

removeSizeListener

 
removeSizeListener(listener)
Removes a listener installed with addSizeListener.
Parameters:
listener - The listener to remove.

restoreState

 
restoreState(view)
Handler called when the view should restore its state not from a cookie.
Parameters:
view - The view that need to restore its state.

See also:
setStateInCookie.

saveState

 
saveState(view)
Handler called when the view should save its state but not in a cookie.
Parameters:
view - The view which state should be saved.
state - A string representing the state of the view.

See also:
setStateInCookie.

setBounds

 
setBounds(left, top, width, height)
Changes the size of the view.
Parameters:
left - The absolute x position of the view on the page.
top - The absolute y position of the view on the page.
width - The width of the view.
height - The height of the view.

setChildrenBounds

 
setChildrenBounds(left, top, width, height)
Changes the size of this view's children. This implementation does nothing. Subclasses should override this method as needed. Warning: This method is considered to be part of an IlvEmptyView's internal implementation and is not a public API.
Parameters:
left - The absolute x position of the view on the page.
top - The absolute y position of the view on the page.
width - The width of the view.
height - The height of the view.

setLocation

 
setLocation(left, top)
Moves this view to the specified location.
Parameters:
left - Position of the left side, relative to the upper-left corner of the window.
top - Position of the top side, relative to the upper-left corner of the window.

setSize

 
setSize(width, height)
Sets the size of this view.
Parameters:
width - The width of the view in pixels.
height - The height of the view in pixels.

setStateInCookie

 
setStateInCookie(stateInCookie)
Sets whether the state of the view should be stored in a cookie or not. The default value is 'true'.

toHTML

 
toHTML()
Creates the HTML for this component. This method must be called once in the body of the HTML page. Do not override this method, override childrenToHTML() instead.

Inherited Methods from IlvObject
callDispose, dispose, getClassName, hashCode, inherits, instanceOf, invoke, registerDispose, removeHTML, setClassName, superConstructor, superInvoke, toString, updateVisibility
 PREV CLASS    Documentation homepage     NEXT CLASS