Class EventCanvas
- All Implemented Interfaces:
HasAttachHandlers,HasHandlers,EventListener,HasVisibility,IsWidget,LogicalStructure,HasClearHandlers,HasClickHandlers,HasDoubleClickHandlers,HasDragMoveHandlers,HasDragRepositionMoveHandlers,HasDragRepositionStartHandlers,HasDragRepositionStopHandlers,HasDragResizeMoveHandlers,HasDragResizeStartHandlers,HasDragResizeStopHandlers,HasDragStartHandlers,HasDragStopHandlers,HasDropHandlers,HasDropMoveHandlers,HasDropOutHandlers,HasDropOverHandlers,HasFocusChangedHandlers,HasHoverHandlers,HasHoverHiddenHandlers,HasKeyDownHandlers,HasKeyPressHandlers,HasMouseDownHandlers,HasMouseMoveHandlers,HasMouseOutHandlers,HasMouseOverHandlers,HasMouseStillDownHandlers,HasMouseUpHandlers,HasMouseWheelHandlers,HasMovedHandlers,HasParentMovedHandlers,HasResizedHandlers,HasRightMouseDownHandlers,HasRuleContextChangedHandlers,HasScrolledHandlers,HasShowContextMenuHandlers,HasVisibilityChangedHandlers,HasMembersChangedHandlers
- Direct Known Subclasses:
IndicatorCanvas,ZoneCanvas
layout subclass for
displaying a CalendarEvent in a CalendarView. Each instance can be styled, and can render a single area, or separate
header and body areas, for the look of a Window.
The component's
close and context buttons, and any necessary resizers, are shown on rollover.
-
Nested Class Summary
Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject
UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled -
Field Summary
Fields inherited from class com.smartgwt.client.widgets.BaseWidget
config, configOnly, factoryCreated, factoryProperties, id, nativeObject, scClassNameFields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic voidchangeAutoChildDefaults(String autoChildName, Canvas defaults) Changes the defaults for Canvas AutoChildren namedautoChildName.static voidchangeAutoChildDefaults(String autoChildName, FormItem defaults) Changes the defaults for FormItem AutoChildren namedautoChildName.protected JavaScriptObjectcreate()Return the HTML to show in the body of this EventCanvas.CSS class for thebody areaof the EventCanvas.TheCalendarin which this EventCanvas is being rendered.TheCalendarViewin which this EventCanvas is being rendered.When set to true, escapes the HTML displayed in this EventCanvas and it's hover.getEvent()Theeventassociated with this EventCanvas.WhenshowGripperis true, this is the component that will be rendered adjacent to the canvas and allow the canvas to be moved with the mouse.The source for the icon displayed as the "gripper" that snaps to the top of an event canvas and allows an event to be dragged with the mouse.Returns the HTML to show in the header of this EventCanvas.CSS class for theheader areaof the EventCanvas.Whether theheader areashould autosize vertically to display all contents.booleanReadonly property dictating whether this is a specialIndicatorCanvassubclass.booleanReadonly property indicating whether this is a specialZoneCanvassubclass.getLabel()WhenshowLabelis true, this autoChild is used to display theheader text, adjacent to this eventCanvas.Getter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility.static EventCanvasgetOrCreateRef(JavaScriptObject jsObj) Renders a body DIV that fills the main area of the canvas, or all of it if noheaderis shown.When set to true, shows asmall iconin the top corner of an EventCanvas, beside theclose-icon.When set to true, shows thegrippercomponent, which snaps, centered, to the top edge of the eventCanvas and can be used to move it with the mouse.When set to true, theheader textfor the associated event is not rendered inside the eventCanvas itself.When set to the default value of true, this attribute causes a set of components to be shown when the mouse rolls over this EventCanvas.The CSS class for this EventCanvas.Indicates the orientation of the event in its containing view.setBodyStyle(String bodyStyle) CSS class for thebody areaof the EventCanvas.setCalendar(Calendar calendar) TheCalendarin which this EventCanvas is being rendered.setCalendarView(CalendarView calendarView) TheCalendarViewin which this EventCanvas is being rendered.static voidsetDefaultProperties(EventCanvas eventCanvasProperties) Class level method to set the default properties of this class.setEscapeHTML(Boolean escapeHTML) When set to true, escapes the HTML displayed in this EventCanvas and it's hover.setEvent(CalendarEvent event) Theeventassociated with this EventCanvas.setGripperIcon(String gripperIcon) The source for the icon displayed as the "gripper" that snaps to the top of an event canvas and allows an event to be dragged with the mouse.setHeaderHeight(Integer headerHeight) setHeaderStyle(String headerStyle) CSS class for theheader areaof the EventCanvas.setHeaderWrap(Boolean headerWrap) Whether theheader areashould autosize vertically to display all contents.Setter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility.setShowBody(Boolean showBody) Renders a body DIV that fills the main area of the canvas, or all of it if noheaderis shown.setShowContextButton(Boolean showContextButton) When set to true, shows asmall iconin the top corner of an EventCanvas, beside theclose-icon.setShowGripper(Boolean showGripper) When set to true, shows thegrippercomponent, which snaps, centered, to the top edge of the eventCanvas and can be used to move it with the mouse.setShowHeader(Boolean showHeader) setShowLabel(Boolean showLabel) When set to true, theheader textfor the associated event is not rendered inside the eventCanvas itself.setShowRolloverControls(Boolean showRolloverControls) When set to the default value of true, this attribute causes a set of components to be shown when the mouse rolls over this EventCanvas.voidsetStyleName(String styleName) The CSS class for this EventCanvas.setVerticalResize(Boolean verticalResize) Indicates the orientation of the event in its containing view.Methods inherited from class com.smartgwt.client.widgets.layout.VLayout
setDefaultProperties, setLogicalStructureMethods inherited from class com.smartgwt.client.widgets.layout.Layout
addMember, addMember, addMember, addMember, addMemberPostCreate, addMemberPostCreate, addMemberPreCreate, addMemberPreCreate, addMembers, addMembers, addMembersChangedHandler, getAnimateMembers, getAnimateMemberTime, getCanDropComponents, getChildTabPosition, getDefaultResizeBars, getDropComponent, getDropLine, getDropLineThickness, getDropPosition, getEditProxyConstructor, getEnforcePolicy, getHPolicy, getLayoutBottomMargin, getLayoutEndMargin, getLayoutLeftMargin, getLayoutMargin, getLayoutRightMargin, getLayoutStartMargin, getLayoutTopMargin, getLeaveScrollbarGap, getLocateMembersBy, getLocateMembersType, getManagePercentBreadth, getMember, getMember, getMemberDefaultBreadth, getMemberNumber, getMemberNumber, getMemberOverlap, getMembers, getMembersLength, getMembersMargin, getMinMemberLength, getMinMemberSize, getOverflow, getPaddingAsLayoutMargin, getResizeBar, getResizeBarClass, getResizeBarSize, getReverseOrder, getShowDragPlaceHolder, getShowDropLines, getStackZIndex, getVertical, getVPolicy, hasMember, hideDropLine, hideMember, hideMember, layoutIsDirty, onInit, onInit_Layout, reflow, reflow, reflowNow, removeMember, removeMembers, removeMembers, reorderMember, reorderMembers, replaceMember, revealChild, revealChild, setAlign, setAlign, setAnimateMembers, setAnimateMemberTime, setCanDropComponents, setDefaultLayoutAlign, setDefaultLayoutAlign, setDefaultProperties, setDefaultResizeBars, setDropLineProperties, setDropLineThickness, setEditProxyConstructor, setEnforcePolicy, setHPolicy, setLayoutBottomMargin, setLayoutEndMargin, setLayoutLeftMargin, setLayoutMargin, setLayoutRightMargin, setLayoutStartMargin, setLayoutTopMargin, setLeaveScrollbarGap, setLocateMembersBy, setLocateMembersType, setLogicalStructure, setManagePercentBreadth, setMemberOverlap, setMembers, setMembersMargin, setMinBreadthMember, setMinBreadthMember, setMinBreadthMember, setMinMemberLength, setMinMemberSize, setOverflow, setPaddingAsLayoutMargin, setPlaceHolderDefaults, setPlaceHolderProperties, setResizeBarClass, setResizeBarSize, setReverseOrder, setShowDragPlaceHolder, setShowDropLines, setStackZIndex, setVertical, setVisibleMember, setVPolicy, showMember, showMemberMethods inherited from class com.smartgwt.client.widgets.Canvas
addChild, addChild, addChild, addChild, addChild, addClearHandler, addClickHandler, addDoubleClickHandler, addDragMoveHandler, addDragRepositionMoveHandler, addDragRepositionStartHandler, addDragRepositionStopHandler, addDragResizeMoveHandler, addDragResizeStartHandler, addDragResizeStopHandler, addDragStartHandler, addDragStopHandler, addDropHandler, addDropMoveHandler, addDropOutHandler, addDropOverHandler, addFocusChangedHandler, addHoverHandler, addHoverHiddenHandler, addKeyDownHandler, addKeyPressHandler, addMouseDownHandler, addMouseMoveHandler, addMouseOutHandler, addMouseOverHandler, addMouseStillDownHandler, addMouseUpHandler, addMouseWheelHandler, addMovedHandler, addParentMovedHandler, addPeer, addPeer, addPeer, addPeer, addResizedHandler, addRightMouseDownHandler, addRuleContextChangedHandler, addScrolledHandler, addShowContextMenuHandler, addSnapAlignCandidate, addStyleName, addVisibilityChangedHandler, adjustForContent, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateHide, animateHide, animateHide, animateHide, animateHide, animateHide, animateHide, animateMove, animateMove, animateMove, animateMove, animateRect, animateRect, animateRect, animateRect, animateResize, animateResize, animateResize, animateResize, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateShow, animateShow, animateShow, animateShow, animateShow, animateShow, animateShow, asSGWTComponent, blur, bringToFront, clear, clearExplicitTabIndex, clickMaskUp, clickMaskUp, contains, contains, containsEvent, containsEventTarget, containsFocus, containsPoint, containsPoint, dataContextChanged, deparent, depeer, disable, doValueDictation, doVoiceCommand, enable, encloses, focus, focusAfterGroup, focusAtEnd, focusInNextTabElement, focusInPreviousTabElement, getAbsoluteLeft, getAbsoluteTop, getAccessKey, getAdaptiveHeightPriority, getAdaptiveWidthPriority, getAlwaysManageFocusNavigation, getAlwaysShowScrollbars, getAnimateAcceleration, getAnimateFadeTime, getAnimateHideAcceleration, getAnimateHideEffect, getAnimateHideTime, getAnimateMoveAcceleration, getAnimateMoveTime, getAnimateRectAcceleration, getAnimateRectTime, getAnimateResizeAcceleration, getAnimateResizeLayoutMode, getAnimateResizeTime, getAnimateScrollAcceleration, getAnimateScrollTime, getAnimateShowAcceleration, getAnimateShowEffect, getAnimateShowTime, getAnimateTime, getAppImgDir, getAriaHandleID, getAriaRole, getAriaStateDefaults, getAutoMaskComponents, getAutoParent, getAutoPopulateData, getAutoShowParent, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBorderRadius, getBottom, getById, getByJSObject, getByLocalId, getCanAcceptDrop, getCanAdaptHeight, getCanAdaptWidth, getCanDrag, getCanDragReposition, getCanDragResize, getCanDragScroll, getCanDrop, getCanDropBefore, getCanFocus, getCanHover, getCanSelectText, getCanvasAutoChild, getCanvasItem, getChildren, getChildrenResizeSnapAlign, getChildrenSnapAlign, getChildrenSnapCenterAlign, getChildrenSnapEdgeAlign, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getClassName, getComponentMask, getComponentMaskDefaults, getContentElement, getContents, getContextMenu, getCorrectZoomOverflow, getCursor, getDataContext, getDataPath, getDefaultHeight, getDefaultWidth, getDefiningProperty, getDefiningPropertyName, getDefiningPropertyNameOptions, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDisableTouchScrollingForDrag, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragMaskType, getDragMaxHeight, getDragMaxWidth, getDragMinHeight, getDragMinWidth, getDragOpacity, getDragRepositionAppearance, getDragRepositionCursor, getDragResizeAppearance, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragTargetAsString, getDragType, getDropTarget, getDropTargetAsString, getDropTypes, getDropTypesAsString, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeMarginSize, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getEditNode, getEditProxy, getElement, getElement, getEnableWhen, getEndLine, getEventEdge, getEventEdge, getExtraSpace, getFacetId, getFloatingScrollbars, getFormItemAutoChild, getForwardSVGeventsToObject, getFullDataPath, getGroupBorderCSS, getGroupLabelBackgroundColor, getGroupLabelStyleName, getGroupPadding, getGroupTitle, getHeight, getHeightAsString, getHideUsingDisplayNone, getHoverAlign, getHoverAutoDestroy, getHoverAutoFitMaxWidth, getHoverAutoFitMaxWidthAsString, getHoverAutoFitWidth, getHoverComponent, getHoverDelay, getHoverFocusKey, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverPersist, getHoverScreen, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapPosition, getHSnapPosition, getHtmlElement, getHtmlElementAsString, getHtmlPosition, getImage, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getIsPrinting, getIsRuleScope, getIsSnapAlignCandidate, getKeepInParentRect, getLayoutAlign, getLeaveGroupLabelSpace, getLeavePageSpace, getLeft, getLeftAsString, getLocalId, getLocateByIDOnly, getLocateChildrenBy, getLocateChildrenType, getLocatePeersBy, getLocatePeersType, getLocatorName, getMargin, getMasterCanvas, getMasterElement, getMatchElement, getMatchElementHeight, getMatchElementWidth, getMaxHeight, getMaxWidth, getMaxZoomOverflowError, getMenuConstructor, getMinHeight, getMinNonEdgeSize, getMinWidth, getMomentumScrollMinSpeed, getMouseStillDownDelay, getMouseStillDownInitialDelay, getName, getNativeAutoHideScrollbars, getNextZIndex, getNoDoubleClicks, getNoDropCursor, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOpacity, getOuterElement, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getPaletteDefaults, getPanelContainer, getParentCanvas, getParentElement, getPeers, getPendingMarkerStyle, getPendingMarkerVisible, getPercentBox, getPercentSource, getPersistentMatchElement, getPointerSettings, getPointerTarget, getPointerTargetAsString, getPosition, getPrefix, getPrintChildrenAbsolutelyPositioned, getPrintHTML, getPrintHTML, getPrintStyleName, getPrompt, getProportionalResizeModifiers, getProportionalResizing, getReceiveScrollbarEvents, getRect, getRedrawOnResize, getResizeBarTarget, getResizeFrom, getRight, getRuleContext, getRuleContext, getRuleScope, getScrollbarSize, getScrollBottom, getScrollHeight, getScrollLeft, getScrollRight, getScrollTop, getScrollWidth, getShadowColor, getShadowDepth, getShadowHOffset, getShadowImage, getShadowOffset, getShadowSoftness, getShadowSpread, getShadowVOffset, getShouldPrint, getShowCustomScrollbars, getShowDragShadow, getShowEdges, getShowHover, getShowHoverComponents, getShowPointer, getShowResizeBar, getShowShadow, getShowSnapGrid, getShrinkElementOnHide, getSizeMayChangeOnRedraw, getSkinImgDir, getSnapAlignCandidates, getSnapAlignCenterLineStyle, getSnapAlignEdgeLineStyle, getSnapAxis, getSnapEdge, getSnapGridLineProperties, getSnapGridStyle, getSnapHDirection, getSnapHGap, getSnapOffsetLeft, getSnapOffsetTop, getSnapOnDrop, getSnapPosition, getSnapPosition, getSnapResizeToAlign, getSnapResizeToGrid, getSnapTo, getSnapToAlign, getSnapToCenterAlign, getSnapToEdgeAlign, getSnapToGrid, getSnapVDirection, getSnapVGap, getStartLine, getTabIndex, getTestDataContext, getTestInstance, getTitle, getTooltip, getTop, getTopAsString, getTopElement, getUISummary, getUpdateTabPositionOnDraw, getUpdateTabPositionOnReparent, getUseBackMask, getUseCSSShadow, getUseDragMask, getUseImageForSVG, getUseNativeDrag, getUseOpacityFilter, getUseTouchScrolling, getValuesManager, getValuesManagerAsString, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWhen, getVisibleWidth, getVSnapPosition, getVSnapPosition, getWidth, getWidthAsString, getWorkflows, getZIndex, getZIndex, handleHover, hide, hideClickMask, hideClickMask, hideComponentMask, hideComponentMask, hideContextMenu, imgHTML, imgHTML, imgHTML, initComplete, intersects, isDirty, isDisabled, isFocused, isVisible, keyUp, layoutChildren, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, markForDestroy, markForRedraw, markForRedraw, moveAbove, moveBelow, moveBy, moveTo, onAttach, onDetach, pageScrollDown, pageScrollUp, parentResized, placeNear, placeNear, placeNear, print, print, print, print, printComponents, provideRuleContext, provideRuleContext, redraw, redraw, registerFontScaledPaddingStyles, removeChild, removeChild, removePeer, removePeer, removeRuleContext, removeSnapAlignCandidate, resizeAutoChildAttributes, resizeBy, resizeControls, resizeControlsTo, resizeFonts, resizeFonts, resizeFonts, resizeFontsTo, resizeIcons, resizePadding, resizePadding, resizeTo, resizeTo, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollTo, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAdaptHeightByCustomizer, setAdaptiveHeightPriority, setAdaptiveWidthPriority, setAdaptWidthByCustomizer, setAllowExternalFilters, setAlwaysManageFocusNavigation, setAlwaysShowScrollbars, setAnimateAcceleration, setAnimateFadeTime, setAnimateHideAcceleration, setAnimateHideEffect, setAnimateHideTime, setAnimateMoveAcceleration, setAnimateMoveTime, setAnimateRectAcceleration, setAnimateRectTime, setAnimateResizeAcceleration, setAnimateResizeLayoutMode, setAnimateResizeTime, setAnimateScrollAcceleration, setAnimateScrollTime, setAnimateShowAcceleration, setAnimateShowEffect, setAnimateShowTime, setAnimateTime, setAppImgDir, setAriaRole, setAriaState, setAutoChildConstructor, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildVisibility, setAutoHeight, setAutoMaskComponents, setAutoParent, setAutoPopulateData, setAutoResizeAutoChildAttributes, setAutoResizeIcons, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBorderRadius, setBottom, setCanAcceptDrop, setCanAdaptHeight, setCanAdaptWidth, setCanDrag, setCanDragReposition, setCanDragResize, setCanDragScroll, setCanDrop, setCanDropBefore, setCanFocus, setCanHover, setCanSelectText, setChildren, setChildrenResizeSnapAlign, setChildrenSnapAlign, setChildrenSnapCenterAlign, setChildrenSnapEdgeAlign, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setComponentMaskDefaults, setContents, setContextMenu, setCorrectZoomOverflow, setCursor, setDataContext, setDataPath, setDefaultHeight, setDefaultPageSpace, setDefaultProperties, setDefaultShowCustomScrollbars, setDefaultWidth, setDefiningProperty, setDefiningPropertyNameOptions, setDisabled, setDisabledCursor, setDisableTouchScrollingForDrag, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragMaskType, setDragMaxHeight, setDragMaxWidth, setDragMinHeight, setDragMinWidth, setDragOpacity, setDragRepositionAppearance, setDragRepositionCursor, setDragResizeAppearance, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragTarget, setDragType, setDropTarget, setDropTarget, setDropTypes, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setEditMode, setEditMode, setEditMode, setElement, setEnableWhen, setEndLine, setExtraSpace, setFacetId, setFloatingScrollbars, setForwardSVGeventsToObject, setGroupBorderCSS, setGroupLabelBackgroundColor, setGroupLabelStyleName, setGroupPadding, setGroupTitle, setHeight, setHeight, setHeight, setHeight100, setHideUsingDisplayNone, setHoverAlign, setHoverAutoDestroy, setHoverAutoFitMaxWidth, setHoverAutoFitMaxWidth, setHoverAutoFitWidth, setHoverDelay, setHoverFocusKey, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverPersist, setHoverScreen, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlElement, setHtmlElement, setHtmlPosition, setImage, setImage, setInitHandler, setIsGroup, setIsRuleScope, setIsSnapAlignCandidate, setKeepInParentRect, setKeepInParentRect, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeaveGroupLabelSpace, setLeavePageSpace, setLeft, setLeft, setLocateByIDOnly, setLocateChildrenBy, setLocateChildrenType, setLocatePeersBy, setLocatePeersType, setLocatorName, setLocatorParent, setLocatorParent, setLogicalStructure, setMargin, setMatchElement, setMatchElementHeight, setMatchElementWidth, setMaxHeight, setMaxWidth, setMaxZoomOverflowError, setMenuConstructor, setMinHeight, setMinNonEdgeSize, setMinWidth, setMomentumScrollMinSpeed, setMouseStillDownDelay, setMouseStillDownInitialDelay, setName, setNativeAutoHideScrollbars, setNeverUseFilters, setNoDoubleClicks, setNoDropCursor, setOpacity, setPadding, setPageLeft, setPageTop, setPanelContainer, setParentCanvas, setParentElement, setPeers, setPendingMarkerStyle, setPendingMarkerVisible, setPercentBox, setPercentSource, setPersistentMatchElement, setPointerSettings, setPointerTarget, setPosition, setPrefix, setPrintChildrenAbsolutelyPositioned, setPrintStyleName, setPrompt, setProportionalResizeModifiers, setProportionalResizing, setReceiveScrollbarEvents, setRect, setRect, setRedrawOnResize, setRelativeTabPosition, setResizeBarTarget, setResizeFrom, setResizeFrom, setRight, setRuleScope, setScrollbarConstructor, setScrollbarSize, setShadowColor, setShadowDepth, setShadowHOffset, setShadowImage, setShadowOffset, setShadowSoftness, setShadowSpread, setShadowVOffset, setShouldPrint, setShowCustomScrollbars, setShowDragShadow, setShowEdges, setShowHover, setShowHoverComponents, setShowPointer, setShowResizeBar, setShowShadow, setShowSnapGrid, setShrinkElementOnHide, setSizeMayChangeOnRedraw, setSkinImgDir, setSmoothFade, setSnapAlignCandidates, setSnapAlignCenterLineStyle, setSnapAlignEdgeLineStyle, setSnapAxis, setSnapEdge, setSnapGridLineProperties, setSnapGridStyle, setSnapHDirection, setSnapHGap, setSnapOffsetLeft, setSnapOffsetTop, setSnapOnDrop, setSnapResizeToAlign, setSnapResizeToGrid, setSnapTo, setSnapToAlign, setSnapToCenterAlign, setSnapToEdgeAlign, setSnapToGrid, setSnapVDirection, setSnapVGap, setStartLine, setTabIndex, setTestDataContext, setTitle, setTooltip, setTop, setTop, setUpdateTabPositionOnDraw, setUpdateTabPositionOnReparent, setUseBackMask, setUseCSSShadow, setUseDragMask, setUseImageForSVG, setUseNativeDrag, setUseOpacityFilter, setUseTouchScrolling, setValuesManager, setValuesManager, setVisibility, setVisible, setVisibleWhen, setWidth, setWidth, setWidth, setWidth100, setWorkflows, setZIndex, shouldDragScroll, show, showClickMask, showComponentMask, showComponentMask, showNextTo, showNextTo, showNextTo, showNextTo, showPendingMarker, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, showRecursively, startDebuggingOverflow, stopDebuggingOverflow, supportsValueDictation, supportsVoiceCommands, updateChildTabPosition, updateChildTabPositions, updateEditNode, updateHover, updateHover, updateShadow, updateTabPositionForDraw, visibleAtPoint, willAcceptDropMethods inherited from class com.smartgwt.client.widgets.BaseWidget
addDrawHandler, addDynamicProperty, addDynamicProperty, addDynamicProperty, addDynamicProperty, applyFactoryProperties, clearDynamicProperty, completeCreation, destroy, doAddHandler, doInit, doOnRender, draw, equals, error, errorIfNotCreated, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDateArray, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsFloatArray, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getConfig, getDOM, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, getScClassName, hasAutoAssignedID, hasDynamicProperty, hashCode, initNativeObject, internalSetID, internalSetID, isConfigOnly, isCreated, isDrawn, isFactoryCreated, onBind, onDestroy, onDraw, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setConfig, setConfigOnly, setDefaultProperties, setDragTracker, setFactoryCreated, setID, setJavaScriptObject, setLogicalStructure, setLogicalStructure, setNullProperty, setPosition, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setScClassName, toStringMethods inherited from class com.google.gwt.user.client.ui.Widget
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEventsMethods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEventMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
-
Constructor Details
-
EventCanvas
public EventCanvas() -
EventCanvas
-
-
Method Details
-
getOrCreateRef
-
changeAutoChildDefaults
Changes the defaults for Canvas AutoChildren namedautoChildName.- Parameters:
autoChildName- name of an AutoChild to customize the defaults for.defaults- Canvas defaults to apply. These defaults override any existing properties without destroying or wiping out non-overridden properties. For usage tips on this param, seeSGWTProperties.- See Also:
-
changeAutoChildDefaults
Changes the defaults for FormItem AutoChildren namedautoChildName.- Parameters:
autoChildName- name of an AutoChild to customize the defaults for.defaults- FormItem defaults to apply. These defaults override any existing properties without destroying or wiping out non-overridden properties. For usage tips on this param, seeSGWTProperties.- See Also:
-
create
-
setBodyStyle
CSS class for thebody areaof the EventCanvas. If unset, defaults to thebase styleNamewith the suffix "Body".- Parameters:
bodyStyle- New bodyStyle value. Default value is null- Returns:
EventCanvasinstance, for chaining setter calls- See Also:
-
getBodyStyle
CSS class for thebody areaof the EventCanvas. If unset, defaults to thebase styleNamewith the suffix "Body".- Returns:
- Current bodyStyle value. Default value is null
- See Also:
-
setCalendar
TheCalendarin which this EventCanvas is being rendered.- Parameters:
calendar- New calendar value. Default value is null- Returns:
EventCanvasinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getCalendar
TheCalendarin which this EventCanvas is being rendered.- Returns:
- Current calendar value. Default value is null
-
setCalendarView
TheCalendarViewin which this EventCanvas is being rendered.- Parameters:
calendarView- New calendarView value. Default value is null- Returns:
EventCanvasinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getCalendarView
TheCalendarViewin which this EventCanvas is being rendered.- Returns:
- Current calendarView value. Default value is null
-
setEscapeHTML
When set to true, escapes the HTML displayed in this EventCanvas and it's hover.- Parameters:
escapeHTML- New escapeHTML value. Default value is null- Returns:
EventCanvasinstance, for chaining setter calls
-
getEscapeHTML
When set to true, escapes the HTML displayed in this EventCanvas and it's hover.- Returns:
- Current escapeHTML value. Default value is null
-
setEvent
Theeventassociated with this EventCanvas.
If this method is called after the component has been drawn/initialized: Assigns a neweventto this EventCanvas, including updates to drag, style androlloverproperties.- Parameters:
event- the new event to apply to this EventCanvas. Default value is null- Returns:
EventCanvasinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getEvent
Theeventassociated with this EventCanvas.- Returns:
- Current event value. Default value is null
-
getGripper
WhenshowGripperis true, this is the component that will be rendered adjacent to the canvas and allow the canvas to be moved with the mouse.This component is an AutoChild named "gripper". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current gripper value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setGripperIcon
The source for the icon displayed as the "gripper" that snaps to the top of an event canvas and allows an event to be dragged with the mouse.- Parameters:
gripperIcon- New gripperIcon value. Default value is null- Returns:
EventCanvasinstance, for chaining setter calls- See Also:
-
getGripperIcon
The source for the icon displayed as the "gripper" that snaps to the top of an event canvas and allows an event to be dragged with the mouse.- Returns:
- Current gripperIcon value. Default value is null
- See Also:
-
setHeaderHeight
The height for theheader area, whenheaderWrapis false andshowBodyis true. IfshowBodyis false, the header area fills the canvas.- Parameters:
headerHeight- New headerHeight value. Default value is null- Returns:
EventCanvasinstance, for chaining setter calls- See Also:
-
getHeaderHeight
The height for theheader area, whenheaderWrapis false andshowBodyis true. IfshowBodyis false, the header area fills the canvas.- Returns:
- Current headerHeight value. Default value is null
- See Also:
-
setHeaderStyle
CSS class for theheader areaof the EventCanvas. If unset, defaults to thebase styleNamewith the suffix "Header".- Parameters:
headerStyle- New headerStyle value. Default value is null- Returns:
EventCanvasinstance, for chaining setter calls- See Also:
-
getHeaderStyle
CSS class for theheader areaof the EventCanvas. If unset, defaults to thebase styleNamewith the suffix "Header".- Returns:
- Current headerStyle value. Default value is null
- See Also:
-
setHeaderWrap
Whether theheader areashould autosize vertically to display all contents. If true, the header will wrap to multiple lines. If false, the header will be sized according to the specifiedheight, or to the full height of the canvas isshowBodyis false.- Parameters:
headerWrap- New headerWrap value. Default value is null- Returns:
EventCanvasinstance, for chaining setter calls- See Also:
-
getHeaderWrap
Whether theheader areashould autosize vertically to display all contents. If true, the header will wrap to multiple lines. If false, the header will be sized according to the specifiedheight, or to the full height of the canvas isshowBodyis false.- Returns:
- Current headerWrap value. Default value is null
- See Also:
-
getIsIndicatorCanvas
Readonly property dictating whether this is a specialIndicatorCanvassubclass.Note : This method should be called only after the widget has been rendered.
- Returns:
- Current isIndicatorCanvas value. Default value is false
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
getIsZoneCanvas
Readonly property indicating whether this is a specialZoneCanvassubclass.Note : This method should be called only after the widget has been rendered.
- Returns:
- Current isZoneCanvas value. Default value is false
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
getLabel
WhenshowLabelis true, this autoChild is used to display theheader text, adjacent to this eventCanvas.This component is an AutoChild named "label". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current label value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setShowBody
Renders a body DIV that fills the main area of the canvas, or all of it if noheaderis shown. This area typically displays anevent description. This area can be styled viabodyStyleand the HTML it shows is retrieved from a call togetBodyHTML(). The default is taken fromCalendar.showEventDescriptions.- Parameters:
showBody- New showBody value. Default value is null- Returns:
EventCanvasinstance, for chaining setter calls
-
getShowBody
Renders a body DIV that fills the main area of the canvas, or all of it if noheaderis shown. This area typically displays anevent description. This area can be styled viabodyStyleand the HTML it shows is retrieved from a call togetBodyHTML(). The default is taken fromCalendar.showEventDescriptions.- Returns:
- Current showBody value. Default value is null
-
setShowContextButton
When set to true, shows asmall iconin the top corner of an EventCanvas, beside theclose-icon. When clicked, shows acontext menucontaining items applicable to this canvas.- Parameters:
showContextButton- New showContextButton value. Default value is false- Returns:
EventCanvasinstance, for chaining setter calls
-
getShowContextButton
When set to true, shows asmall iconin the top corner of an EventCanvas, beside theclose-icon. When clicked, shows acontext menucontaining items applicable to this canvas.- Returns:
- Current showContextButton value. Default value is false
-
setShowGripper
When set to true, shows thegrippercomponent, which snaps, centered, to the top edge of the eventCanvas and can be used to move it with the mouse.- Parameters:
showGripper- New showGripper value. Default value is null- Returns:
EventCanvasinstance, for chaining setter calls
-
getShowGripper
When set to true, shows thegrippercomponent, which snaps, centered, to the top edge of the eventCanvas and can be used to move it with the mouse.- Returns:
- Current showGripper value. Default value is null
-
setShowHeader
Renders a header DIV above the main body of the event, an area of limited height, styled to stand out from the mainbodyof the event, and typically showing anameor title - like a Window. This header area can be styled viaheaderStyleand the HTML it shows is retrieved from a call togetHeaderHTML(). The default is taken fromCalendar.showEventHeaders.- Parameters:
showHeader- New showHeader value. Default value is null- Returns:
EventCanvasinstance, for chaining setter calls
-
getShowHeader
Renders a header DIV above the main body of the event, an area of limited height, styled to stand out from the mainbodyof the event, and typically showing anameor title - like a Window. This header area can be styled viaheaderStyleand the HTML it shows is retrieved from a call togetHeaderHTML(). The default is taken fromCalendar.showEventHeaders.- Returns:
- Current showHeader value. Default value is null
-
setShowLabel
When set to true, theheader textfor the associated event is not rendered inside the eventCanvas itself.Instead, it is rendered in it's own
labeland shown as a peer of this eventCanvas, immediately outside of it.- Parameters:
showLabel- New showLabel value. Default value is null- Returns:
EventCanvasinstance, for chaining setter calls
-
getShowLabel
When set to true, theheader textfor the associated event is not rendered inside the eventCanvas itself.Instead, it is rendered in it's own
labeland shown as a peer of this eventCanvas, immediately outside of it.- Returns:
- Current showLabel value. Default value is null
-
setShowRolloverControls
When set to the default value of true, this attribute causes a set of components to be shown when the mouse rolls over this EventCanvas. These components include thecloseandcontextbuttons, the latter'scontext menuand the images used for drag-resizing.Using rollover controls is more efficient that showing static buttons in each eventCanvas, so this is the default behavior. See
Calendar.useEventCanvasRolloverControlsfor the alternative.- Parameters:
showRolloverControls- New showRolloverControls value. Default value is true- Returns:
EventCanvasinstance, for chaining setter calls
-
getShowRolloverControls
When set to the default value of true, this attribute causes a set of components to be shown when the mouse rolls over this EventCanvas. These components include thecloseandcontextbuttons, the latter'scontext menuand the images used for drag-resizing.Using rollover controls is more efficient that showing static buttons in each eventCanvas, so this is the default behavior. See
Calendar.useEventCanvasRolloverControlsfor the alternative.- Returns:
- Current showRolloverControls value. Default value is true
-
setStyleName
The CSS class for this EventCanvas. Defaults to the style oneventCanvas.event, if specified, or on thecalendarotherwise.Also see
headerStyleandbodyStyle.- Overrides:
setStyleNamein classCanvas- Parameters:
styleName- New styleName value. Default value is null- See Also:
-
getStyleName
The CSS class for this EventCanvas. Defaults to the style oneventCanvas.event, if specified, or on thecalendarotherwise.Also see
headerStyleandbodyStyle.- Overrides:
getStyleNamein classCanvas- Returns:
- Current styleName value. Default value is null
- See Also:
-
setVerticalResize
Indicates the orientation of the event in its containing view. Affects drag and resize orientation and which edges of the canvas are available for resizing.- Parameters:
verticalResize- New verticalResize value. Default value is null- Returns:
EventCanvasinstance, for chaining setter calls
-
getVerticalResize
Indicates the orientation of the event in its containing view. Affects drag and resize orientation and which edges of the canvas are available for resizing.- Returns:
- Current verticalResize value. Default value is null
-
getBodyHTML
Return the HTML to show in the body of this EventCanvas. The default implementation callsCalendar.getEventBodyHTML(), which returns the value of thedescription fieldfor the currentevent.- Returns:
- HTML to display in the body of the canvas.
See
HTMLString - See Also:
-
getHeaderHTML
Returns the HTML to show in the header of this EventCanvas. The default implementation returns thenameof the currentevent.- Returns:
- HTML to display in the header of the canvas.
See
HTMLString - See Also:
-
setDefaultProperties
Class level method to set the default properties of this class. If set, then all existing and subsequently created instances of this class will automatically have default properties corresponding to the properties set on the SmartGWT class instance passed to this function before its underlying SmartClient JS object was created. This is a powerful feature that eliminates the need for users to create a separate hierarchy of subclasses that only alter the default properties of this class. Can also be used for skinning / styling purposes.Note: This method is intended for setting default attributes only and will affect all instances of the underlying class (including those automatically generated in JavaScript). This method should not be used to apply standard EventHandlers or override methods for a class - use a custom subclass instead. Calling this method after instances have been created can result in undefined behavior, since it bypasses any setters and a class instance may have already examined a particular property and not be expecting any changes through this route.
- Parameters:
eventCanvasProperties- properties that should be used as new defaults when instances of this class are created- See Also:
-
setLogicalStructure
Setter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility. -
getLogicalStructure
Getter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility.- Specified by:
getLogicalStructurein interfaceLogicalStructure- Overrides:
getLogicalStructurein classVLayout
-