qx.ui.core
Class ClientDocument

java.lang.Object
  qx.core.Object
      qx.core.Target
          qx.ui.core.Widget
              qx.ui.core.Parent
                  qx.ui.layout.CanvasLayout
                      qx.ui.core.ClientDocument

public class ClientDocument
extends CanvasLayout

This is the basic widget of all qooxdoo applications.

qx.ui.core.ClientDocument is the parent of all children inside your application. It also handles their resizing and focus navigation.

Field Summary

Fields inherited from class qx.ui.core.Widget

AUTO

Constructor Summary

ClientDocument()

Method Summary

void	_applyParent(Parent value, Parent old) Applies changes of the property value of the property parent.
java.lang.Object	_computeInnerHeight()
java.lang.Object	_computeInnerWidth()
ClientDocumentBlocker	_getBlocker() Returns the blocker widget if already created; otherwise create it first
void	_onwindowresize(Event e)
java.lang.Object	addCssRule(java.lang.Object vSheet, java.lang.Object vSelector, java.lang.Object vStyle)
void	block(java.lang.Object vActiveChild)
void	blockHelper(Event e)
java.lang.Object	createStyleElement(java.lang.Object vCssText)
java.lang.Object	getDocumentElement()
java.lang.String	getGlobalCursor() Returns the (computed) value of the property globalCursor.
static ClientDocument	getInstance() TODO: generic solution for static methods
Parent	getParent() Returns the (computed) value of the property parent.
ToolTip	getToolTip() Returns the (computed) value of the property toolTip.
java.lang.Object	getTopLevelWidget() The widget which is at the top level, which contains all others (normally a instance of qx.ui.core.ClientDocument).
java.lang.Object	getWindowElement()
void	initGlobalCursor(java.lang.String arg) Calls the apply method and dispatches the change event of the property globalCursor with the default value defined by the class developer.
boolean	isMaterialized() If the widget is visible and rendered on the screen.
boolean	isSeeable() If the widget is currently seeable which means that it:
void	release(java.lang.Object vActiveChild)
java.lang.Object	removeAllCssRules(java.lang.Object vSheet)
java.lang.Object	removeCssRule(java.lang.Object vSheet, java.lang.Object vSelector)
void	resetGlobalCursor() Resets the user value of the property globalCursor.
void	setGlobalCursor(java.lang.String arg) Sets the user value of the property globalCursor.

Methods inherited from class qx.ui.layout.CanvasLayout

_createLayoutImpl

Methods inherited from class qx.ui.core.Parent

_addChildrenToLayoutQueue, _addChildrenToStateQueue, _addChildToChildrenQueue, _afterAppear, _afterDisappear, _afterInsertDom, _afterRemoveDom, _applyActiveChild, _applyFocusedChild, _applyFocusHandler, _beforeAppear, _beforeDisappear, _beforeInsertDom, _beforeRemoveDom, _changeInnerHeight, _changeInnerWidth, _computePreferredInnerHeight, _computePreferredInnerWidth, _computeVisibleChildren, _flushChildrenQueue, _handleDisplayableCustom, _layoutChild, _layoutPost, _onfocuskeyevent, _recursiveAppearanceThemeUpdate, _removeChildFromChildrenQueue, activateFocusRoot, add, addAfter, addAt, addAtBegin, addAtEnd, addBefore, contains, forEachChild, forEachVisibleChild, getActiveChild, getChildren, getChildrenLength, getFirstActiveChild, getFirstChild, getFirstVisibleChild, getFocusedChild, getFocusHandler, getFocusRoot, getInnerHeightForChild, getInnerWidthForChild, getLastActiveChild, getLastChild, getLastVisibleChild, getLayoutImpl, getVisibleChildrenLength, hasChildren, hasVisibleChildren, indexOf, initActiveChild, initFocusedChild, initFocusHandler, isEmpty, isFocusRoot, isVisibleEmpty, recursiveAddToStateQueue, remapChildrenHandlingTo, remove, removeAll, removeAt, resetActiveChild, resetFocusedChild, resetFocusHandler, setActiveChild, setFocusedChild, setFocusHandler

Methods inherited from class qx.ui.core.Widget

_applyAppearance, _applyBackgroundColor, _applyBackgroundImage, _applyBackgroundRepeat, _applyBorder, _applyBottom, _applyCapture, _applyClip, _applyCommand, _applyCursor, _applyDisplay, _applyElement, _applyElementData, _applyEnabled, _applyFocused, _applyFont, _applyHeight, _applyHideFocus, _applyHtmlAttributes, _applyHtmlProperties, _applyLeft, _applyMarginBottom, _applyMarginLeft, _applyMarginRight, _applyMarginTop, _applyMaxHeight, _applyMaxWidth, _applyMinHeight, _applyMinWidth, _applyOpacity, _applyOverflow, _applyPaddingBottom, _applyPaddingLeft, _applyPaddingRight, _applyPaddingTop, _applyParent, _applyRight, _applySelectable, _applyStateStyleFocus, _applyStyleProperties, _applyTabIndex, _applyTextColor, _applyTop, _applyVisibility, _applyWidth, _applyZIndex, _checkParent, _compileClipString, _computeBoxHeight, _computeBoxHeightFallback, _computeBoxWidth, _computeBoxWidthFallback, _computeDisplayable, _computeFrameHeight, _computeFrameWidth, _computeHasAutoX, _computeHasAutoY, _computeHasFlexX, _computeHasFlexY, _computeHasPercentX, _computeHasPercentY, _computeOuterHeight, _computeOuterWidth, _computePreferredBoxHeight, _computePreferredBoxWidth, _computeValuePercentX, _computeValuePercentXLimit, _computeValuePercentY, _computeValuePercentYLimit, _computeValuePixel, _computeValuePixelLimit, _createElementImpl, _evalUnitsPixelPercent, _evalUnitsPixelPercentAuto, _evalUnitsPixelPercentAutoFlex, _flushJobQueue, _generateHtmlId, _getTargetNode, _handleDisplayable, _invalidateFrameDimensions, _invalidatePreferredInnerDimensions, _queueBorder, _recomputeFlexX, _recomputeFlexY, _recomputePercentX, _recomputePercentY, _recomputeRangeX, _recomputeRangeY, _recomputeStretchingX, _recomputeStretchingY, _renderAppearance, _renderOverflow, _resetAppearanceThemeWrapper, _styleBackgroundColor, _styleBackgroundImage, _styleFromMap, _unitDetectionPixelPercent, _unitDetectionPixelPercentAuto, _unitDetectionPixelPercentAutoFlex, _unstyleFromArray, _visualizeBlur, _visualizeFocus, _visualPropertyCheck, addState, addToDocument, addToJobQueue, addToLayoutChanges, addToQueue, addToQueueRuntime, addToStateQueue, auto, blur, connect, contains, disconnect, execute, focus, getAllowStretchX, getAllowStretchY, getAnonymous, getAppearance, getBackgroundColor, getBackgroundImage, getBackgroundRepeat, getBorder, getBottom, getBottomValue, getCapture, getClientHeight, getClientWidth, getClipHeight, getClipLeft, getClipTop, getClipWidth, getCommand, getContextMenu, getCursor, getDisplay, getDropDataTypes, getElement, getEnabled, getEnableElementFocus, getFocused, getFont, getHeight, getHeightValue, getHideFocus, getHorizontalAlign, getHtmlAttribute, getHtmlProperty, getLeft, getLeftValue, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getMaxHeight, getMaxHeightValue, getMaxWidth, getMaxWidthValue, getMinHeight, getMinHeightValue, getMinWidth, getMinWidthValue, getNeededHeight, getNeededWidth, getNextActiveSibling, getNextSibling, getNextVisibleSibling, getOffsetHeight, getOffsetLeft, getOffsetTop, getOffsetWidth, getOpacity, getOverflow, getOverflowX, getOverflowY, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getPreviousActiveSibling, getPreviousSibling, getPreviousVisibleSibling, getRight, getRightValue, getScrollHeight, getScrollLeft, getScrollTop, getScrollWidth, getSelectable, getStyleProperty, getSupportsDropMethod, getTabIndex, getTextColor, getTop, getTopValue, getVerticalAlign, getVisibility, getVisibleChildren, getWidth, getWidthValue, getZIndex, hasState, hide, indexOf, initAllowStretchX, initAllowStretchY, initAnonymous, initAppearance, initBackgroundColor, initBackgroundImage, initBackgroundRepeat, initBorder, initBottom, initCapture, initClipHeight, initClipLeft, initClipTop, initClipWidth, initCommand, initContextMenu, initCursor, initDisplay, initDropDataTypes, initElement, initEnabled, initEnableElementFocus, initFocused, initFont, initHeight, initHideFocus, initHorizontalAlign, initLeft, initMarginBottom, initMarginLeft, initMarginRight, initMarginTop, initMaxHeight, initMaxWidth, initMinHeight, initMinWidth, initOpacity, initOverflow, initPaddingBottom, initPaddingLeft, initPaddingRight, initPaddingTop, initParent, initRight, initSelectable, initSupportsDropMethod, initTabIndex, initTextColor, initToolTip, initTop, initVerticalAlign, initVisibility, initWidth, initZIndex, isAllowStretchX, isAllowStretchY, isAnonymous, isAppearRelevant, isCapture, isCreated, isDisplay, isDisplayable, isEnabled, isEnableElementFocus, isFirstChild, isFirstVisibleChild, isFocusable, isFocused, isHideFocus, isLastChild, isLastVisibleChild, isSelectable, isVisibility, moveSelfAfter, moveSelfBefore, moveSelfToBegin, moveSelfToEnd, pack, removeHtmlAttribute, removeHtmlProperty, removeState, removeStyleProperty, renderPadding, resetAlign, resetAllowStretchX, resetAllowStretchY, resetAnonymous, resetAppearance, resetBackgroundColor, resetBackgroundImage, resetBackgroundRepeat, resetBorder, resetBottom, resetCapture, resetClip, resetClipDimension, resetClipHeight, resetClipLeft, resetClipLocation, resetClipTop, resetClipWidth, resetCommand, resetContextMenu, resetCursor, resetDimension, resetDisplay, resetDropDataTypes, resetEdge, resetElement, resetEnabled, resetEnableElementFocus, resetFocused, resetFont, resetHeight, resetHeights, resetHideFocus, resetHorizontalAlign, resetLeft, resetLocation, resetMargin, resetMarginBottom, resetMarginLeft, resetMarginRight, resetMarginTop, resetMaxHeight, resetMaxWidth, resetMinHeight, resetMinWidth, resetOpacity, resetOverflow, resetPadding, resetPaddingBottom, resetPaddingLeft, resetPaddingRight, resetPaddingTop, resetParent, resetRight, resetSelectable, resetSpace, resetSupportsDropMethod, resetTabIndex, resetTextColor, resetToolTip, resetTop, resetVerticalAlign, resetVisibility, resetWidth, resetWidths, resetZIndex, scrollIntoView, scrollIntoViewX, scrollIntoViewY, setAlign, setAllowStretchX, setAllowStretchY, setAnonymous, setAppearance, setBackgroundColor, setBackgroundImage, setBackgroundRepeat, setBorder, setBottom, setCapture, setClip, setClipDimension, setClipHeight, setClipLeft, setClipLocation, setClipTop, setClipWidth, setCommand, setContextMenu, setCursor, setDimension, setDisplay, setDropDataTypes, setEdge, setElement, setEnabled, setEnableElementFocus, setFocused, setFont, setHeight, setHeights, setHideFocus, setHorizontalAlign, setHtmlAttribute, setHtmlProperty, setLeft, setLocation, setMargin, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setOpacity, setOverflow, setPadding, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddingTop, setParent, setRight, setScrollLeft, setScrollTop, setSelectable, setSpace, setStyleProperty, setSupportsDropMethod, setTabIndex, setTextColor, setToolTip, setTop, setVerticalAlign, setVisibility, setWidth, setWidths, setZIndex, show, supportsDrop, toggleAllowStretchX, toggleAllowStretchY, toggleAnonymous, toggleCapture, toggleDisplay, toggleEnabled, toggleEnableElementFocus, toggleFocused, toggleHideFocus, toggleSelectable, toggleVisibility

Methods inherited from class qx.core.Target

_dispatchEvent, addChangeSelectionListener, addChangeValueListener, addEventListener, addExecuteListener, addJavaEventListener, createDispatchChangeEvent, createDispatchDataEvent, createDispatchEvent, dispatchEvent, hasEventListeners, removeEventListener

Methods inherited from class qx.core.Object

_disposeFields, _disposeObjectDeep, _disposeObjects, base, dispose, get, getDisposed, isDisposed, reset, self, set, toHashCode, toString_

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ClientDocument

public ClientDocument()

Method Detail

_applyParent

public void _applyParent(Parent value,
                         Parent old)

Applies changes of the property value of the property parent.

For further details take a look at the property definition: _applyParent(qx.ui.core.Parent, qx.ui.core.Parent).

_computeInnerHeight

public java.lang.Object _computeInnerHeight()

Overrides:

_computeInnerHeight in class Widget

_computeInnerWidth

public java.lang.Object _computeInnerWidth()

Overrides:

_computeInnerWidth in class Widget

_getBlocker

public ClientDocumentBlocker _getBlocker()

Returns the blocker widget if already created; otherwise create it first

_onwindowresize

public void _onwindowresize(Event e)

addCssRule

public java.lang.Object addCssRule(java.lang.Object vSheet,
                                   java.lang.Object vSelector,
                                   java.lang.Object vStyle)

block

public void block(java.lang.Object vActiveChild)

blockHelper

public void blockHelper(Event e)

createStyleElement

public java.lang.Object createStyleElement(java.lang.Object vCssText)

getDocumentElement

public java.lang.Object getDocumentElement()

getGlobalCursor

public java.lang.String getGlobalCursor()

Returns the (computed) value of the property globalCursor.

For further details take a look at the property definition: globalCursor.

getParent

public Parent getParent()

Description copied from class: Widget

Returns the (computed) value of the property parent.

For further details take a look at the property definition: Widget.parent.

Overrides:

getParent in class Widget

getToolTip

public ToolTip getToolTip()

Description copied from class: Widget

Returns the (computed) value of the property toolTip.

For further details take a look at the property definition: Widget.toolTip.

Overrides:

getToolTip in class Widget

getTopLevelWidget

public java.lang.Object getTopLevelWidget()

Description copied from class: Widget

The widget which is at the top level, which contains all others (normally a instance of qx.ui.core.ClientDocument).

Overrides:

getTopLevelWidget in class Widget

getWindowElement

public java.lang.Object getWindowElement()

initGlobalCursor

public void initGlobalCursor(java.lang.String arg)

Calls the apply method and dispatches the change event of the property globalCursor with the default value defined by the class developer. This function can only be called from the constructor of a class.

For further details take a look at the property definition: globalCursor.

isMaterialized

public boolean isMaterialized()

Description copied from class: Widget

If the widget is visible and rendered on the screen.

Overrides:

isMaterialized in class Widget

isSeeable

public boolean isSeeable()

Description copied from class: Widget

If the widget is currently seeable which means that it:

• has a also seeable parent
• visibility is true
• display is true

Overrides:

isSeeable in class Widget

release

public void release(java.lang.Object vActiveChild)

removeAllCssRules

public java.lang.Object removeAllCssRules(java.lang.Object vSheet)

removeCssRule

public java.lang.Object removeCssRule(java.lang.Object vSheet,
                                      java.lang.Object vSelector)

resetGlobalCursor

public void resetGlobalCursor()

Resets the user value of the property globalCursor.

The computed value falls back to the next available value e.g. appearance, init or inheritance value depeneding on the property configuration and value availability.

For further details take a look at the property definition: globalCursor.

setGlobalCursor

public void setGlobalCursor(java.lang.String arg)

Sets the user value of the property globalCursor.

For further details take a look at the property definition: globalCursor.

getInstance

public static ClientDocument getInstance()

TODO: generic solution for static methods