com.smartgwt.client.widgets
Class EdgedCanvas

java.lang.Object
  com.google.gwt.user.client.ui.UIObject
      com.google.gwt.user.client.ui.Widget
          com.smartgwt.client.widgets.BaseWidget
              com.smartgwt.client.widgets.Canvas
                  com.smartgwt.client.widgets.EdgedCanvas

All Implemented Interfaces:

HasAttachHandlers, HasHandlers, EventListener, IsWidget, 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, HasScrolledHandlers, HasShowContextMenuHandlers, HasVisibilityChangedHandlers

public class EdgedCanvas
extends Canvas

EdgedCanvas acts as a decorative, image-based frame around another single Canvas.

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, id, isElementSet, scClassName

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

EdgedCanvas()

EdgedCanvas(JavaScriptObject jsObj)

Method Summary

protected JavaScriptObject	create()
Boolean	getAddEdgeStyleSuffix() If specified, the edgeStyleName will be treated as a base style name and appended with following suffixes to support separate styling per cell:
String	getCenterBackgroundColor() Background color for the center section only.
Integer	getEdgeBottom() Height in pixels for bottom corners and edges.
String	getEdgeColor() CSS color (WITHOUT "#") for the edges.
String	getEdgeImage() Base name of images for edges.
Integer	getEdgeLeft() Height in pixels for left corners and edges.
Integer	getEdgeOffsetBottom() Amount the contained Canvas should be offset from the bottom.
Integer	getEdgeOffsetLeft() Amount the contained Canvas should be offset from the left.
Integer	getEdgeOffsetRight() Amount the contained Canvas should be offset from the right.
Integer	getEdgeOffsetTop() Amount the contained Canvas should be offset from the top.
Integer	getEdgeRight() Height in pixels for right corners and edges.
String	getEdgeStyleName() Optional property specifying the CSS ClassName to apply to the various parts of this edged canvas (top, bottom, corners, sides and center).
Integer	getEdgeTop() Height in pixels for top corners and edges.
static EdgedCanvas	getOrCreateRef(JavaScriptObject jsObj)
Boolean	getShowCenter() Whether to show media in the center section, that is, behind the decorated Canvas.
String	getSkinImgDir() Standard skin directory for edge images (sides and corners).
static void	preloadImages() Preload primary EdgedCanvas images.
void	setAddEdgeStyleSuffix(Boolean addEdgeStyleSuffix) If specified, the edgeStyleName will be treated as a base style name and appended with following suffixes to support separate styling per cell:
void	setCenterBackgroundColor(String centerBackgroundColor) Background color for the center section only.
static void	setDefaultProperties(EdgedCanvas edgedCanvasProperties) Class level method to set the default properties of this class.
void	setEdgeBottom(Integer edgeBottom) Height in pixels for bottom corners and edges.
void	setEdgeColor(String edgeColor) CSS color (WITHOUT "#") for the edges.
void	setEdgeImage(String edgeImage) Base name of images for edges.
void	setEdgeLeft(Integer edgeLeft) Height in pixels for left corners and edges.
void	setEdgeOffsetBottom(Integer edgeOffsetBottom) Amount the contained Canvas should be offset from the bottom.
void	setEdgeOffsetLeft(Integer edgeOffsetLeft) Amount the contained Canvas should be offset from the left.
void	setEdgeOffsetRight(Integer edgeOffsetRight) Amount the contained Canvas should be offset from the right.
void	setEdgeOffsetTop(Integer edgeOffsetTop) Amount the contained Canvas should be offset from the top.
void	setEdgeRight(Integer edgeRight) Height in pixels for right corners and edges.
void	setEdgeStyleName(String edgeStyleName) Optional property specifying the CSS ClassName to apply to the various parts of this edged canvas (top, bottom, corners, sides and center).
void	setEdgeTop(Integer edgeTop) Height in pixels for top corners and edges.
void	setShowCenter(Boolean showCenter) Whether to show media in the center section, that is, behind the decorated Canvas.
void	setSkinImgDir(String skinImgDir) Standard skin directory for edge images (sides and corners).

Methods inherited from class com.smartgwt.client.widgets.Canvas

addChild, addChild, addChild, 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, addResizedHandler, addRightMouseDownHandler, addScrolledHandler, addShowContextMenuHandler, addStyleName, addVisibilityChangedHandler, adjustForContent, animateFade, animateFade, animateFade, animateHide, animateHide, animateHide, animateMove, animateMove, animateMove, animateMove, animateRect, animateRect, animateRect, animateResize, animateResize, animateResize, animateScroll, animateScroll, animateScroll, animateShow, animateShow, animateShow, blur, bringToFront, clear, clickMaskUp, clickMaskUp, contains, contains, containsEvent, containsFocus, containsPoint, containsPoint, convertToCanvasArray, disable, enable, focus, getAbsoluteLeft, getAbsoluteTop, getAccessKey, getAnimateAcceleration, getAnimateFadeTime, getAnimateHideAcceleration, getAnimateHideTime, getAnimateMoveAcceleration, getAnimateMoveTime, getAnimateRectAcceleration, getAnimateRectTime, getAnimateResizeAcceleration, getAnimateResizeTime, getAnimateScrollAcceleration, getAnimateScrollTime, getAnimateShowAcceleration, getAnimateShowEffect, getAnimateShowTime, getAnimateTime, getAppImgDir, getAriaRole, getAutoDraw, getAutoShowParent, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBottom, getById, getCanAcceptDrop, getCanDrag, getCanDragReposition, getCanDragResize, getCanDragScroll, getCanDrop, getCanDropBefore, getCanFocus, getCanHover, getCanSelectText, getCanvasItem, getChildren, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getContents, getContextMenu, getCursor, getDataPath, getDefaultHeight, getDefaultWidth, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragOpacity, getDragRepositionAppearance, getDragRepositionCursor, getDragResizeAppearance, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragType, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeMarginSize, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getExtraSpace, getFacetId, getFullDataPath, getGroupTitle, getHeight, getHeightAsString, getHoverAlign, getHoverAutoDestroy, getHoverComponent, getHoverDelay, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapOrigin, getHSnapOrigin, getHSnapPosition, getHSnapPosition, getHtmlPosition, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getLeft, getLeftAsString, getLocateChildrenBy, getLocateChildrenType, getLocatePeersBy, getLocatePeersType, getMargin, getMatchElement, getMaxHeight, getMaxWidth, getMenuConstructor, getMinHeight, getMinWidth, getMouseStillDownDelay, getMouseStillDownInitialDelay, getNextZIndex, getNoDoubleClicks, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOpacity, getOverflow, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getParentElement, getPercentBox, getPosition, getPrefix, getPrintHTML, getPrintHTML, getPrompt, getRect, getRedrawOnResize, getResizeBarTarget, getRight, getScrollbarSize, getScrollBottom, getScrollHeight, getScrollLeft, getScrollRight, getScrollTop, getScrollWidth, getShadowDepth, getShadowImage, getShadowOffset, getShadowSoftness, getShouldPrint, getShowCustomScrollbars, getShowDragShadow, getShowEdges, getShowHover, getShowHoverComponents, getShowResizeBar, getShowShadow, getSnapAxis, getSnapEdge, getSnapHDirection, getSnapHGap, getSnapOffsetLeft, getSnapOffsetTop, getSnapOnDrop, getSnapResizeToGrid, getSnapTo, getSnapToGrid, getSnapVDirection, getSnapVGap, getStyleName, getTabIndex, getTitle, getTooltip, getTop, getTopAsString, getUseOpacityFilter, getValuesManager, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWidth, getVSnapOrigin, getVSnapOrigin, getVSnapPosition, getVSnapPosition, getWidth, getWidthAsString, getZIndex, handleHover, hide, hideClickMask, hideClickMask, hideContextMenu, imgHTML, imgHTML, imgHTML, intersects, isDirty, isDisabled, isDrawn, isVisible, keyUp, layoutChildren, linkHTML, linkHTML, markForDestroy, markForRedraw, markForRedraw, moveAbove, moveBelow, moveBy, moveTo, onInit, parentResized, printComponents, redraw, redraw, removeChild, removeChild, resizeBy, resizeTo, resizeTo, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAlign, setAllowExternalFilters, setAnimateAcceleration, setAnimateFadeTime, setAnimateHideAcceleration, setAnimateHideTime, setAnimateMoveAcceleration, setAnimateMoveTime, setAnimateRectAcceleration, setAnimateRectTime, setAnimateResizeAcceleration, setAnimateResizeTime, setAnimateScrollAcceleration, setAnimateScrollTime, setAnimateShowAcceleration, setAnimateShowEffect, setAnimateShowTime, setAnimateTime, setAppImgDir, setAriaRole, setAutoDraw, setAutoHeight, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBottom, setCanAcceptDrop, setCanDrag, setCanDragReposition, setCanDragResize, setCanDragScroll, setCanDrop, setCanDropBefore, setCanFocus, setCanHover, setCanSelectText, setCanvasItem, setChildren, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setContents, setContextMenu, setCursor, setDataPath, setDefaultHeight, setDefaultProperties, setDefaultWidth, setDisabled, setDisabledCursor, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragOpacity, setDragRepositionAppearance, setDragRepositionCursor, setDragResizeAppearance, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragType, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setExtraSpace, setFacetId, setGroupTitle, setHeight, setHeight, setHeight100, setHoverAlign, setHoverAutoDestroy, setHoverDelay, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlPosition, setImage, setImage, setIsGroup, setKeepInParentRect, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeft, setLeft, setLocateChildrenBy, setLocateChildrenType, setLocatePeersBy, setLocatePeersType, setMargin, setMatchElement, setMaxHeight, setMaxWidth, setMenuConstructor, setMinHeight, setMinWidth, setMouseStillDownDelay, setMouseStillDownInitialDelay, setNeverUseFilters, setNoDoubleClicks, setOpacity, setOverflow, setPadding, setPageLeft, setPageTop, setParentElement, setPercentBox, setPosition, setPrefix, setPrompt, setRect, setRect, setRedrawOnResize, setResizeBarTarget, setResizeFrom, setRight, setScrollbarSize, setShadowDepth, setShadowImage, setShadowOffset, setShadowSoftness, setShouldPrint, setShowCustomScrollbars, setShowDragShadow, setShowEdges, setShowHover, setShowHoverComponents, setShowResizeBar, setShowShadow, setSmoothFade, setSnapAxis, setSnapEdge, setSnapHDirection, setSnapHGap, setSnapOffsetLeft, setSnapOffsetTop, setSnapOnDrop, setSnapResizeToGrid, setSnapTo, setSnapToGrid, setSnapVDirection, setSnapVGap, setStyleName, setTabIndex, setTitle, setTooltip, setTop, setTop, setUseOpacityFilter, setValuesManager, setVisibility, setVisible, setWidth, setWidth, setWidth100, setZIndex, shouldDragScroll, show, showClickMask, showNextTo, showNextTo, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, showRecursively, updateHover, updateHover, updateShadow, visibleAtPoint, willAcceptDrop

Methods inherited from class com.smartgwt.client.widgets.BaseWidget

addDrawHandler, destroy, doAddHandler, doInit, doOnRender, draw, equals, error, errorIfNotCreated, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsFloatArray, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsString, getAttributeAsStringArray, getConfig, getDOM, getElement, getElement, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, getScClassName, hashCode, isConfigOnly, isCreated, onDestroy, onDraw, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setConfig, setConfigOnly, setDragTracker, setElement, setHtmlElement, setID, setNullProperty, setPosition, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setScClassName, toString

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent, unsinkEvents

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

Constructor Detail

EdgedCanvas

public EdgedCanvas()

EdgedCanvas

public EdgedCanvas(JavaScriptObject jsObj)

Method Detail

getOrCreateRef

public static EdgedCanvas getOrCreateRef(JavaScriptObject jsObj)

create

protected JavaScriptObject create()

Overrides:

create in class Canvas

setAddEdgeStyleSuffix

public void setAddEdgeStyleSuffix(Boolean addEdgeStyleSuffix)

If specified, the edgeStyleName will be treated as a base style name and appended with following suffixes to support separate styling per cell:

_TL (top left cell)
_T (top center cell)
_TR (top right cell)
_L (middle left cell)
_C (center cell)
_R (middle right cell)
_BL (bottom left cell)
_B (bottom center cell)
_BR (bottom right cell)

Parameters:

addEdgeStyleSuffix - addEdgeStyleSuffix Default value is false

getAddEdgeStyleSuffix

public Boolean getAddEdgeStyleSuffix()

If specified, the edgeStyleName will be treated as a base style name and appended with following suffixes to support separate styling per cell:

_TL (top left cell)
_T (top center cell)
_TR (top right cell)
_L (middle left cell)
_C (center cell)
_R (middle right cell)
_BL (bottom left cell)
_B (bottom center cell)
_BR (bottom right cell)

Returns:

Boolean

setCenterBackgroundColor

public void setCenterBackgroundColor(String centerBackgroundColor)
                              throws IllegalStateException

Background color for the center section only. Can be used as a surrogate background color for the decorated Canvas, if the Canvas is set to partially overlap the edges and hence can't show a background color itself without occluding media.

Parameters:

centerBackgroundColor - centerBackgroundColor Default value is null

Throws:

IllegalStateException - this property cannot be changed after the component has been created

getCenterBackgroundColor

public String getCenterBackgroundColor()

Background color for the center section only. Can be used as a surrogate background color for the decorated Canvas, if the Canvas is set to partially overlap the edges and hence can't show a background color itself without occluding media.

Returns:

String

setEdgeBottom

public void setEdgeBottom(Integer edgeBottom)
                   throws IllegalStateException

Height in pixels for bottom corners and edges. Defaults to edgeSize when unset.

Parameters:

edgeBottom - edgeBottom Default value is null

Throws:

IllegalStateException - this property cannot be changed after the component has been created

getEdgeBottom

public Integer getEdgeBottom()

Height in pixels for bottom corners and edges. Defaults to edgeSize when unset.

Returns:

Integer

setEdgeColor

public void setEdgeColor(String edgeColor)
                  throws IllegalStateException

CSS color (WITHOUT "#") for the edges. If specified, will be used as part of image names. Example: "edge_88FF88_TL.gif".

Parameters:

edgeColor - edgeColor Default value is null

Throws:

IllegalStateException - this property cannot be changed after the component has been created

getEdgeColor

public String getEdgeColor()

CSS color (WITHOUT "#") for the edges. If specified, will be used as part of image names. Example: "edge_88FF88_TL.gif".

Returns:

String

setEdgeImage

public void setEdgeImage(String edgeImage)
                  throws IllegalStateException

Base name of images for edges. Extensions for each corner or edge piece will be added to this image URL, before the extension. For example, with the default base name of "edge.gif", the top-left corner image will be "edge_TL.gif".

The full list of extensions is: "_TL", "_TR", "_BL", "_BR", "_T", "_L", "_B", "_R", "_center".

Overrides:

setEdgeImage in class Canvas

Parameters:

edgeImage - edgeImage Default value is "[SKIN]/rounded/frame/FFFFFF/6.png"

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

Edges Example

getEdgeImage

public String getEdgeImage()

Base name of images for edges. Extensions for each corner or edge piece will be added to this image URL, before the extension. For example, with the default base name of "edge.gif", the top-left corner image will be "edge_TL.gif".

The full list of extensions is: "_TL", "_TR", "_BL", "_BR", "_T", "_L", "_B", "_R", "_center".

Overrides:

getEdgeImage in class Canvas

Returns:

String

See Also:

Edges Example

setEdgeLeft

public void setEdgeLeft(Integer edgeLeft)
                 throws IllegalStateException

Height in pixels for left corners and edges. Defaults to edgeSize when unset.

Parameters:

edgeLeft - edgeLeft Default value is null

Throws:

IllegalStateException - this property cannot be changed after the component has been created

getEdgeLeft

public Integer getEdgeLeft()

Height in pixels for left corners and edges. Defaults to edgeSize when unset.

Returns:

Integer

setEdgeOffsetBottom

public void setEdgeOffsetBottom(Integer edgeOffsetBottom)
                         throws IllegalStateException

Amount the contained Canvas should be offset from the bottom. Defaults to the size for the bottom edge. Set smaller to allow the contained Canvas to overlap the edge and corner media.

Note : This is an advanced setting

Parameters:

edgeOffsetBottom - edgeOffsetBottom Default value is null

Throws:

IllegalStateException - this property cannot be changed after the component has been created

getEdgeOffsetBottom

public Integer getEdgeOffsetBottom()

Amount the contained Canvas should be offset from the bottom. Defaults to the size for the bottom edge. Set smaller to allow the contained Canvas to overlap the edge and corner media.

Returns:

Integer

setEdgeOffsetLeft

public void setEdgeOffsetLeft(Integer edgeOffsetLeft)
                       throws IllegalStateException

Amount the contained Canvas should be offset from the left. Defaults to the size for the left edge. Set smaller to allow the contained Canvas to overlap the edge and corner media.

Note : This is an advanced setting

Parameters:

edgeOffsetLeft - edgeOffsetLeft Default value is null

Throws:

IllegalStateException - this property cannot be changed after the component has been created

getEdgeOffsetLeft

public Integer getEdgeOffsetLeft()

Amount the contained Canvas should be offset from the left. Defaults to the size for the left edge. Set smaller to allow the contained Canvas to overlap the edge and corner media.

Returns:

Integer

setEdgeOffsetRight

public void setEdgeOffsetRight(Integer edgeOffsetRight)
                        throws IllegalStateException

Amount the contained Canvas should be offset from the right. Defaults to the size for the right edge. Set smaller to allow the contained Canvas to overlap the edge and corner media.

Note : This is an advanced setting

Parameters:

edgeOffsetRight - edgeOffsetRight Default value is null

Throws:

IllegalStateException - this property cannot be changed after the component has been created

getEdgeOffsetRight

public Integer getEdgeOffsetRight()

Amount the contained Canvas should be offset from the right. Defaults to the size for the right edge. Set smaller to allow the contained Canvas to overlap the edge and corner media.

Returns:

Integer

setEdgeOffsetTop

public void setEdgeOffsetTop(Integer edgeOffsetTop)
                      throws IllegalStateException

Amount the contained Canvas should be offset from the top. Defaults to the size for the top edge. Set smaller to allow the contained Canvas to overlap the edge and corner media.

Note : This is an advanced setting

Parameters:

edgeOffsetTop - edgeOffsetTop Default value is null

Throws:

IllegalStateException - this property cannot be changed after the component has been created

getEdgeOffsetTop

public Integer getEdgeOffsetTop()

Amount the contained Canvas should be offset from the top. Defaults to the size for the top edge. Set smaller to allow the contained Canvas to overlap the edge and corner media.

Returns:

Integer

setEdgeRight

public void setEdgeRight(Integer edgeRight)
                  throws IllegalStateException

Height in pixels for right corners and edges. Defaults to edgeSize when unset.

Parameters:

edgeRight - edgeRight Default value is null

Throws:

IllegalStateException - this property cannot be changed after the component has been created

getEdgeRight

public Integer getEdgeRight()

Height in pixels for right corners and edges. Defaults to edgeSize when unset.

Returns:

Integer

setEdgeStyleName

public void setEdgeStyleName(String edgeStyleName)

Optional property specifying the CSS ClassName to apply to the various parts of this edged canvas (top, bottom, corners, sides and center). To apply separate styles for each part, use addEdgeStyleSuffix.

Parameters:

edgeStyleName - edgeStyleName Default value is null

getEdgeStyleName

public String getEdgeStyleName()

Optional property specifying the CSS ClassName to apply to the various parts of this edged canvas (top, bottom, corners, sides and center). To apply separate styles for each part, use addEdgeStyleSuffix.

Returns:

String

setEdgeTop

public void setEdgeTop(Integer edgeTop)
                throws IllegalStateException

Height in pixels for top corners and edges. Defaults to edgeSize when unset.

Parameters:

edgeTop - edgeTop Default value is null

Throws:

IllegalStateException - this property cannot be changed after the component has been created

getEdgeTop

public Integer getEdgeTop()

Height in pixels for top corners and edges. Defaults to edgeSize when unset.

Returns:

Integer

setShowCenter

public void setShowCenter(Boolean showCenter)
                   throws IllegalStateException

Whether to show media in the center section, that is, behind the decorated Canvas.

Parameters:

showCenter - showCenter Default value is false

Throws:

IllegalStateException - this property cannot be changed after the component has been created

getShowCenter

public Boolean getShowCenter()

Whether to show media in the center section, that is, behind the decorated Canvas.

Returns:

Boolean

setSkinImgDir

public void setSkinImgDir(String skinImgDir)
                   throws IllegalStateException

Standard skin directory for edge images (sides and corners).

Overrides:

setSkinImgDir in class Canvas

Parameters:

skinImgDir - skinImgDir Default value is "images/edges/"

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

Images overview and related methods

getSkinImgDir

public String getSkinImgDir()

Standard skin directory for edge images (sides and corners).

Overrides:

getSkinImgDir in class Canvas

Returns:

String

See Also:

Images overview and related methods

setDefaultProperties

public static void setDefaultProperties(EdgedCanvas edgedCanvasProperties)

Class level method to set the default properties of this class. If set, then all subsequent instances of this class will automatically have the default properties that were set when this method was called. 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 effect 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.

Parameters:

edgedCanvasProperties - properties that should be used as new defaults when instances of this class are created

preloadImages

public static void preloadImages()

Preload primary EdgedCanvas images.