/** * Default time for performing an animated resize. If unset, <code>this.animateTime</code> will be used by default instead * <p><b>Note : </b> This is an advanced setting</p> * * @param animateResizeTime animateResizeTime Default value is null */ public void setAnimateResizeTime(Integer animateResizeTime) { setAttribute("animateResizeTime", animateResizeTime, true); }
/** * If true, causes this canvas's children to snap to its grid when dragging. This behavior can be overridden on a per-child * basis by setting the {@link com.smartgwt.client.widgets.Canvas#getSnapToGrid snapToGrid} value on the child. * * @param childrenSnapToGrid childrenSnapToGrid Default value is null * @see com.smartgwt.client.docs.Dragdrop Dragdrop overview and related methods */ public void setChildrenSnapToGrid(Boolean childrenSnapToGrid) { setAttribute("childrenSnapToGrid", childrenSnapToGrid, true); }
/** * The contents of a canvas or label widget. Any HTML string is acceptable. * Changes the contents of a widget to newContents, an HTML string. <P> When {@link com.smartgwt.client.widgets.Canvas#getDynamicContents dynamicContents} is set, <code>setContents()</code> can also be called with no arguments to cause contents to be re-evaluated. * <p><b>Note : </b> This is an advanced setting</p> * * @param contents an HTML string to be set as the contents of this widget. Default value is " " * @see com.smartgwt.client.widgets.Canvas#setDynamicContents */ public void setContents(String contents) { setAttribute("contents", contents, true); }
/** * 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". <P> * The full list of extensions is: "_TL", "_TR", "_BL", "_BR", "_T", "_L", "_B", "_R", "_center". * * @param edgeImage edgeImage Default value is "[SKIN]edge.gif" * @throws IllegalStateException this property cannot be changed after the component has been created * @see <a href="http://www.smartclient.com/smartgwt/showcase/#effects_lf_edges" target="examples">Edges Example</a> */ public void setEdgeImage(String edgeImage) throws IllegalStateException { setAttribute("edgeImage", edgeImage, false); }
/** * Size in pixels for corners and edges * * @param edgeSize edgeSize Default value is 10 * @throws IllegalStateException this property cannot be changed after the component has been created * @see <a href="http://www.smartclient.com/smartgwt/showcase/#effects_lf_edges" target="examples">Edges Example</a> */ public void setEdgeSize(int edgeSize) throws IllegalStateException { setAttribute("edgeSize", edgeSize, false); }
/** * When this Canvas is included as a member in a Layout, extra blank space that should be left after this member in a * Layout. * * @param extraSpace extraSpace Default value is 0 * @throws IllegalStateException this property cannot be changed after the component has been created * @see com.smartgwt.client.widgets.layout.LayoutSpacer * @see com.smartgwt.client.docs.LayoutMember LayoutMember overview and related methods */ public void setExtraSpace(int extraSpace) throws IllegalStateException { setAttribute("extraSpace", extraSpace, false); }
/** * If <code>this.canHover</code> is true, how long should the mouse be kept over this widget before the hover event is * fired * * @param hoverDelay hoverDelay Default value is 300 * @see com.smartgwt.client.widgets.Canvas#setCanHover * @see com.smartgwt.client.widgets.events.HoverEvent */ public void setHoverDelay(int hoverDelay) { setAttribute("hoverDelay", hoverDelay, true); }
/** * If <code>this.showHover</code> is true, this property can be used to customize the height of the hover canvas shown. * * @param hoverHeight hoverHeight Default value is null * @see com.smartgwt.client.widgets.Canvas#setShowHover */ public void setHoverHeight(Integer hoverHeight) { setAttribute("hoverHeight", hoverHeight, true); }
/** * If <code>this.showHover</code> is true, this property can be used to specify the css style to apply to the hover canvas. * * @param hoverStyle hoverStyle Default value is null * @see com.smartgwt.client.widgets.Canvas#setShowHover * @see <a href="http://www.smartclient.com/smartgwt/showcase/#basics_interaction_hovers" target="examples">Hovers / Tooltips Example</a> */ public void setHoverStyle(String hoverStyle) { setAttribute("hoverStyle", hoverStyle, true); }
/** * Maximum height that this Canvas can be resized to. * <p><b>Note : </b> This is an advanced setting</p> * * @param maxHeight maxHeight Default value is 10000 * @see com.smartgwt.client.docs.Sizing Sizing overview and related methods */ public void setMaxHeight(int maxHeight) { setAttribute("maxHeight", maxHeight, true); }
/** * Prompt displayed in hover canvas if {@link com.smartgwt.client.widgets.Canvas#getShowHover showHover} is true. * * @param prompt prompt Default value is null * @see <a href="http://www.smartclient.com/smartgwt/showcase/#basics_interaction_hovers" target="examples">Hovers / Tooltips Example</a> */ public void setPrompt(String prompt) { setAttribute("prompt", prompt, true); }
/** * Should this element be redrawn in response to a resize? <P> Should be set to true for components whose {@link * com.smartgwt.client.widgets.Canvas#getInnerHTML inner HTML} will not automatically reflow to fit the component's new * size. * <p><b>Note : </b> This is an advanced setting</p> * * @param redrawOnResize redrawOnResize Default value is true * @see com.smartgwt.client.docs.Drawing Drawing overview and related methods */ public void setRedrawOnResize(Boolean redrawOnResize) { setAttribute("redrawOnResize", redrawOnResize, true); }
/** * Whether this canvas should be included in a printable view. <P> Default is to: <ul> <li> omit all peers (edges generated * by showEdges:true, etc) <li> omit anything considered a "control", such as a button or menu (see {@link * com.smartgwt.client.util.PrintProperties#getOmitControls omitControls}) <li> include everything else not marked * shouldPrint:false </ul> * * @param shouldPrint shouldPrint Default value is null * @see com.smartgwt.client.docs.Printing Printing overview and related methods */ public void setShouldPrint(Boolean shouldPrint) { setAttribute("shouldPrint", shouldPrint, true); }
/** * Whether to show a drop shadow for this Canvas * Method to update {@link com.smartgwt.client.widgets.Canvas#getShowShadow showShadow}. * * @param showShadow true if the shadow should be visible false if not. Default value is false * @throws IllegalStateException this property cannot be changed after the component has been created * @see <a href="http://www.smartclient.com/smartgwt/showcase/#effects_lf_shadows" target="examples">Shadows Example</a> */ public void setShowShadow(Boolean showShadow) throws IllegalStateException { setAttribute("showShadow", showShadow, false); }
/** * Default animation effect to use if {@link Canvas#animateShow()} is called without an explicit effect parameter. * * @param animateShowEffect the animate show effect. Default is "wipe" */ public void setAnimateShowEffect(AnimationEffect animateShowEffect) { setAttribute("animateShowEffect", animateShowEffect, true); }
/** * If set to true, the widget will be disabled. A widget is only considered enabled if it is individually enabled and * all parents above it in the containment hierarchy are enabled. This allows you to enable or disable all components * of a complex nested widget by enabling or disabling the top-level parent only. * set the disabled state of this object * <p><b>Note : </b> This is an advanced setting</p> * * @param disabled new disabled state of this object - pass <code>true</code> to disable the widget. Default value is false */ public void setDisabled(boolean disabled) { setAttribute("disabled", disabled, true); }
/** * If this canvas is being displayed in a {@link com.smartgwt.client.widgets.form.fields.CanvasItem}, this property will be * set to point at the item. Otherwise this property will be null. * * @param canvasItem canvasItem Default value is null * @throws IllegalStateException this property cannot be changed after the component has been created */ public void setCanvasItem(CanvasItem canvasItem) throws IllegalStateException { setAttribute("canvasItem", canvasItem.getJsObj(), false); }
/** * Visual appearance to show when the object is being dragged. * <p><b>Note : </b> This is an advanced setting</p> * * @param dragAppearance dragAppearance Default value is EventHandler.OUTLINE * @see com.smartgwt.client.docs.Dragdrop Dragdrop overview and related methods */ public void setDragAppearance(DragAppearance dragAppearance) { setAttribute("dragAppearance", dragAppearance.getValue(), true); }
/** * {@link com.smartgwt.client.types.LocatorTypeStrategy} to use when finding children within this canvas. * <p><b>Note : </b> This is an advanced setting</p> * * @param locateChildrenType locateChildrenType Default value is null */ public void setLocateChildrenType(LocatorTypeStrategy locateChildrenType) { setAttribute("locateChildrenType", locateChildrenType.getValue(), true); }
/** * Controls widget visibility when the widget is initialized. See Visibility type for details. * Sets this widget's visibility to "inherit", so that it becomes visible if all it's parents are visible or it has no parents. <P> If the widget has not yet been drawn (and doesn't have a parent or master), this method calls the draw method as well. * * @param visibility visibility Default value is Canvas.INHERIT * @see com.smartgwt.client.docs.Appearance Appearance overview and related methods */ public void setVisibility(Visibility visibility) { setAttribute("visibility", visibility.getValue(), true); }