com.smartgwt.client.widgets.tile
Class TileLayout

java.lang.Object
  extended by com.google.gwt.user.client.ui.UIObject
      extended by com.google.gwt.user.client.ui.Widget
          extended by com.smartgwt.client.widgets.BaseWidget
              extended by com.smartgwt.client.widgets.Canvas
                  extended by com.smartgwt.client.widgets.tile.TileLayout
All Implemented Interfaces:
HasHandlers, com.google.gwt.user.client.EventListener, 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, HasResizedHandlers, HasRightMouseDownHandlers, HasScrolledHandlers, HasShowContextMenuHandlers
Direct Known Subclasses:
TileGrid

public class TileLayout
extends Canvas

Lays out a series of components, calls "tiles", in a grid with multiple tiles per row.


Nested Class Summary
 
Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject
com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled
 
Field Summary
 
Fields inherited from class com.smartgwt.client.widgets.BaseWidget
config, configOnly, id, isElementSet
 
Fields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX
 
Constructor Summary
TileLayout()
           
TileLayout(com.google.gwt.core.client.JavaScriptObject jsObj)
           
 
Method Summary
 void addTile(Canvas tile)
          Add a tile to the layout, dynamically.
 void addTile(Canvas tile, int index)
          Add a tile to the layout, dynamically.
protected  com.google.gwt.core.client.JavaScriptObject create()
           
 java.lang.Boolean getAnimateTileChange()
          If set, tiles animate to their new positions when a tile is added, removed, or reordered via drag and drop.
 java.lang.Boolean getAutoWrapLines()
          When LayoutPolicy is "flow", should we automatically start a new line when there's not enough room to fit the next tile on the same line?
 DragDataAction getDragDataAction()
          Indicates what to do with data dragged into another DataBoundComponent.
 java.lang.Boolean getExpandMargins()
          With LayoutPolicy:"fit", should margins be expanded so that tiles fill the available space in the TileLayout on the breadth axis?
 int getLayoutMargin()
          A margin left around the outside of all tiles.
static TileLayout getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
           
 Orientation getOrientation()
          Direction of tiling.
 Overflow getOverflow()
          Normal Overflow settings can be used on TileLayouts, for example, an overflow:auto TileLayout will scroll if members exceed its specified size, whereas an overflow:visible TileLayout will grow to accomodate members.
 java.lang.Boolean getPaddingAsLayoutMargin()
          If this widget has padding specified (as padding or in the CSS style applied to this layout), should it show up as space outside the members, similar to layoutMargin?
 Canvas getTile(int index)
          Retrieve a tile by index.
 java.lang.Integer getTileHeight()
          Height of each tile in pixels.
 java.lang.Integer getTileHMargin()
          Horizontal margin in between tiles.
 int getTileMargin()
          Margin in between tiles.
 int getTileSize()
          Size of each tile in pixels.
 java.lang.Integer getTilesPerLine()
          Number of tiles to show in each line.
 java.lang.Integer getTileVMargin()
          Vertical margin in between tiles.
 java.lang.Integer getTileWidth()
          Width of each tile in pixels.
 void layoutTiles()
          Forces layout out the tiles
 boolean removeTile(Canvas tile)
          Remove a tile from the layout.
 boolean removeTile(int tileIndex)
          Remove a tile from the layout.
 boolean removeTile(java.lang.String tileID)
          Remove a tile from the layout.
 void setAnimateTileChange(java.lang.Boolean animateTileChange)
          If set, tiles animate to their new positions when a tile is added, removed, or reordered via drag and drop.
 void setAutoWrapLines(java.lang.Boolean autoWrapLines)
          When LayoutPolicy is "flow", should we automatically start a new line when there's not enough room to fit the next tile on the same line?
 void setDragDataAction(DragDataAction dragDataAction)
          Indicates what to do with data dragged into another DataBoundComponent.
 void setExpandMargins(java.lang.Boolean expandMargins)
          With LayoutPolicy:"fit", should margins be expanded so that tiles fill the available space in the TileLayout on the breadth axis?
 void setLayoutMargin(int layoutMargin)
          A margin left around the outside of all tiles.
 void setLayoutPolicy(TileLayoutPolicy layoutPolicy)
          Policy for laying out tiles.
 void setOrientation(Orientation orientation)
          Direction of tiling.
 void setOverflow(Overflow overflow)
          Normal Overflow settings can be used on TileLayouts, for example, an overflow:auto TileLayout will scroll if members exceed its specified size, whereas an overflow:visible TileLayout will grow to accomodate members.
 void setPaddingAsLayoutMargin(java.lang.Boolean paddingAsLayoutMargin)
          If this widget has padding specified (as padding or in the CSS style applied to this layout), should it show up as space outside the members, similar to layoutMargin?
 void setTileHeight(java.lang.Integer tileHeight)
          Height of each tile in pixels.
 void setTileHMargin(java.lang.Integer tileHMargin)
          Horizontal margin in between tiles.
 void setTileMargin(int tileMargin)
          Margin in between tiles.
 void setTiles(Canvas... tiles)
          List of tiles to lay out.
 void setTileSize(int tileSize)
          Size of each tile in pixels.
 void setTilesPerLine(java.lang.Integer tilesPerLine)
          Number of tiles to show in each line.
 void setTileVMargin(java.lang.Integer tileVMargin)
          Vertical margin in between tiles.
 void setTileWidth(java.lang.Integer tileWidth)
          Width of each tile in pixels.
 
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, addPeer, addPeer, addResizedHandler, addRightMouseDownHandler, addScrolledHandler, addShowContextMenuHandler, addStyleName, 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, getAnimateShowTime, getAnimateTime, getAppImgDir, getAutoShowParent, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBottom, getById, getCanAcceptDrop, getCanDrag, getCanDragReposition, getCanDragResize, getCanDragScroll, getCanDrop, getCanDropBefore, getCanFocus, getCanHover, getCanSelectText, getChildren, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getContents, getContextMenu, getCursor, getDefaultHeight, getDefaultWidth, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragOpacity, getDragRepositionCursor, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragType, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getExtraSpace, getGroupTitle, getHeight, getHeightAsString, getHoverAlign, getHoverDelay, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapOrigin, getHSnapOrigin, getHSnapPosition, getHSnapPosition, getHtmlPosition, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getLeft, getMargin, getMatchElement, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getMouseStillDownDelay, getMouseStillDownInitialDelay, getNextZIndex, getNoDoubleClicks, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOpacity, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getParentElement, getPercentBox, getPosition, getPrefix, getPrompt, getRect, getRedrawOnResize, getResizeBarTarget, getRight, getScrollbarSize, getScrollBottom, getScrollHeight, getScrollLeft, getScrollRight, getScrollTop, getScrollWidth, getShadowDepth, getShadowImage, getShadowOffset, getShadowSoftness, getShowCustomScrollbars, getShowDragShadow, getShowEdges, getShowHover, getShowResizeBar, getShowShadow, getSkinImgDir, getSnapAxis, getSnapEdge, getSnapHDirection, getSnapHGap, getSnapOffsetLeft, getSnapOffsetTop, getSnapOnDrop, getSnapResizeToGrid, getSnapTo, getSnapToGrid, getSnapVDirection, getSnapVGap, getStyleName, getTabIndex, getTitle, getTooltip, getTop, 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, parentResized, redraw, redraw, removeChild, removeChild, resizeBy, resizeBy, resizeTo, resizeTo, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAlign, setAnimateAcceleration, setAnimateFadeTime, setAnimateHideAcceleration, setAnimateHideTime, setAnimateMoveAcceleration, setAnimateMoveTime, setAnimateRectAcceleration, setAnimateRectTime, setAnimateResizeAcceleration, setAnimateResizeTime, setAnimateScrollAcceleration, setAnimateScrollTime, setAnimateShowAcceleration, setAnimateShowTime, setAnimateTime, setAppImgDir, setAutoHeight, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBottom, setCanAcceptDrop, setCanDrag, setCanDragReposition, setCanDragResize, setCanDragScroll, setCanDrop, setCanDropBefore, setCanFocus, setCanHover, setCanSelectText, setChildren, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setContents, setContextMenu, setCursor, setDefaultHeight, setDefaultWidth, setDisabled, setDisabledCursor, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragOpacity, setDragRepositionCursor, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragType, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setExtraSpace, setGroupTitle, setHeight, setHeight, setHeight100, setHoverAlign, setHoverDelay, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlPosition, setImage, setImage, setIsGroup, setKeepInParentRect, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeft, setMargin, setMatchElement, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setMouseStillDownDelay, setMouseStillDownInitialDelay, setNoDoubleClicks, setOpacity, setPadding, setPageLeft, setPageTop, setParentElement, setPercentBox, setPosition, setPrefix, setPrompt, setRect, setRect, setRedrawOnResize, setResizeBarTarget, setResizeFrom, setRight, setScrollbarSize, setShadowDepth, setShadowImage, setShadowOffset, setShadowSoftness, setShowCustomScrollbars, setShowDragShadow, setShowEdges, setShowHover, setShowResizeBar, setShowShadow, setSkinImgDir, setSmoothFade, setSnapAxis, setSnapEdge, setSnapHDirection, setSnapHGap, setSnapOffsetLeft, setSnapOffsetTop, setSnapOnDrop, setSnapResizeToGrid, setSnapTo, setSnapToGrid, setSnapVDirection, setSnapVGap, setStyleName, setTabIndex, setTitle, setTooltip, setTop, setVisibility, setVisible, setWidth, setWidth, setWidth100, setZIndex, shouldDragScroll, show, showNextTo, showNextTo, showPrintPreview, updateHover, updateHover, updateShadow, visibleAtPoint, 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, getAttributeAsInt, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsString, getAttributeAsStringArray, getConfig, getDOM, getElement, getElement, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, hashCode, isConfigOnly, isCreated, onDestroy, onDraw, onInit, 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, toString
 
Methods inherited from class com.google.gwt.user.client.ui.Widget
doAttachChildren, doDetachChildren, getParent, isAttached, onAttach, onBrowserEvent, onDetach, onLoad, onUnload, removeFromParent
 
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, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkEvents, 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
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 

Constructor Detail

TileLayout

public TileLayout()

TileLayout

public TileLayout(com.google.gwt.core.client.JavaScriptObject jsObj)
Method Detail

getOrCreateRef

public static TileLayout getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)

create

protected com.google.gwt.core.client.JavaScriptObject create()
Overrides:
create in class Canvas

setTileSize

public void setTileSize(int tileSize)
                 throws java.lang.IllegalStateException
Size of each tile in pixels. Depending on the LayoutPolicy, tileSize may be taken as a maximum, minimum or exact size of tiles, or may be irrelevant.

Width and height may be separately set via tileHeight and tileWidth. sets the height and width of tiles

Parameters:
tileSize - size. Default value is 50
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getTileSize

public int getTileSize()
Size of each tile in pixels. Depending on the LayoutPolicy, tileSize may be taken as a maximum, minimum or exact size of tiles, or may be irrelevant.

Width and height may be separately set via tileHeight and tileWidth.

Returns:
int

setTileWidth

public void setTileWidth(java.lang.Integer tileWidth)
                  throws java.lang.IllegalStateException
Width of each tile in pixels. See tileSize. sets the width of tiles

Parameters:
tileWidth - width. Default value is null
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getTileWidth

public java.lang.Integer getTileWidth()
Width of each tile in pixels. See tileSize.

Returns:
Integer

setTileHeight

public void setTileHeight(java.lang.Integer tileHeight)
                   throws java.lang.IllegalStateException
Height of each tile in pixels. See tileSize. sets the height of tiles

Parameters:
tileHeight - height. Default value is null
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getTileHeight

public java.lang.Integer getTileHeight()
Height of each tile in pixels. See tileSize.

Returns:
Integer

setTileMargin

public void setTileMargin(int tileMargin)
                   throws java.lang.IllegalStateException
Margin in between tiles. Can be set on a per-axis basis with tileHMargin and tileVMargin. sets the width of tiles

Parameters:
tileMargin - margin. Default value is 10
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getTileMargin

public int getTileMargin()
Margin in between tiles. Can be set on a per-axis basis with tileHMargin and tileVMargin.

Returns:
int

setTileHMargin

public void setTileHMargin(java.lang.Integer tileHMargin)
                    throws java.lang.IllegalStateException
Horizontal margin in between tiles. See tileMargin. sets the width of tiles

Parameters:
tileHMargin - width. Default value is null
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getTileHMargin

public java.lang.Integer getTileHMargin()
Horizontal margin in between tiles. See tileMargin.

Returns:
Integer

setTileVMargin

public void setTileVMargin(java.lang.Integer tileVMargin)
                    throws java.lang.IllegalStateException
Vertical margin in between tiles. See tileMargin. sets the width of tiles

Parameters:
tileVMargin - width. Default value is null
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getTileVMargin

public java.lang.Integer getTileVMargin()
Vertical margin in between tiles. See tileMargin.

Returns:
Integer

setLayoutMargin

public void setLayoutMargin(int layoutMargin)
                     throws java.lang.IllegalStateException
A margin left around the outside of all tiles.

Parameters:
layoutMargin - layoutMargin Default value is 5
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getLayoutMargin

public int getLayoutMargin()
A margin left around the outside of all tiles.

Returns:
int

setPaddingAsLayoutMargin

public void setPaddingAsLayoutMargin(java.lang.Boolean paddingAsLayoutMargin)
If this widget has padding specified (as padding or in the CSS style applied to this layout), should it show up as space outside the members, similar to layoutMargin?

If this setting is false, padding will not affect member positioning (as CSS padding normally does not affect absolutely positioned children). Leaving this setting true allows a designer to more effectively control layout purely from CSS.

Note that layoutMargin if specified, takes precidence over this value.

Note : This is an advanced setting

Parameters:
paddingAsLayoutMargin - paddingAsLayoutMargin Default value is true

getPaddingAsLayoutMargin

public java.lang.Boolean getPaddingAsLayoutMargin()
If this widget has padding specified (as padding or in the CSS style applied to this layout), should it show up as space outside the members, similar to layoutMargin?

If this setting is false, padding will not affect member positioning (as CSS padding normally does not affect absolutely positioned children). Leaving this setting true allows a designer to more effectively control layout purely from CSS.

Note that layoutMargin if specified, takes precidence over this value.

Returns:
Boolean

setAnimateTileChange

public void setAnimateTileChange(java.lang.Boolean animateTileChange)
If set, tiles animate to their new positions when a tile is added, removed, or reordered via drag and drop.

Note : This is an advanced setting

Parameters:
animateTileChange - animateTileChange Default value is true

getAnimateTileChange

public java.lang.Boolean getAnimateTileChange()
If set, tiles animate to their new positions when a tile is added, removed, or reordered via drag and drop.

Returns:
Boolean

setOrientation

public void setOrientation(Orientation orientation)
                    throws java.lang.IllegalStateException
Direction of tiling. See also com.smartgwt.client..TileLayoutPolicy.

Parameters:
orientation - orientation Default value is "horizontal"
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getOrientation

public Orientation getOrientation()
Direction of tiling. See also com.smartgwt.client..TileLayoutPolicy.

Returns:
Orientation

setTilesPerLine

public void setTilesPerLine(java.lang.Integer tilesPerLine)
                     throws java.lang.IllegalStateException
Number of tiles to show in each line. Auto-derived from tileSize for some layout modes. See com.smartgwt.client..TileLayoutPolicy.

Parameters:
tilesPerLine - tilesPerLine Default value is null
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getTilesPerLine

public java.lang.Integer getTilesPerLine()
Number of tiles to show in each line. Auto-derived from tileSize for some layout modes. See com.smartgwt.client..TileLayoutPolicy.

Returns:
Integer

setOverflow

public void setOverflow(Overflow overflow)
                 throws java.lang.IllegalStateException
Normal Overflow settings can be used on TileLayouts, for example, an overflow:auto TileLayout will scroll if members exceed its specified size, whereas an overflow:visible TileLayout will grow to accomodate members.

Overrides:
setOverflow in class Canvas
Parameters:
overflow - overflow Default value is "visible"
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getOverflow

public Overflow getOverflow()
Normal Overflow settings can be used on TileLayouts, for example, an overflow:auto TileLayout will scroll if members exceed its specified size, whereas an overflow:visible TileLayout will grow to accomodate members.

Overrides:
getOverflow in class Canvas
Returns:
Overflow

setExpandMargins

public void setExpandMargins(java.lang.Boolean expandMargins)
                      throws java.lang.IllegalStateException
With LayoutPolicy:"fit", should margins be expanded so that tiles fill the available space in the TileLayout on the breadth axis?

Parameters:
expandMargins - expandMargins Default value is true
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getExpandMargins

public java.lang.Boolean getExpandMargins()
With LayoutPolicy:"fit", should margins be expanded so that tiles fill the available space in the TileLayout on the breadth axis?

Returns:
Boolean

setAutoWrapLines

public void setAutoWrapLines(java.lang.Boolean autoWrapLines)
                      throws java.lang.IllegalStateException
When LayoutPolicy is "flow", should we automatically start a new line when there's not enough room to fit the next tile on the same line?

If set to false, a new line will only be started if a tile specifies tile.startLine or tile.endLine.

Parameters:
autoWrapLines - autoWrapLines Default value is true
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getAutoWrapLines

public java.lang.Boolean getAutoWrapLines()
When LayoutPolicy is "flow", should we automatically start a new line when there's not enough room to fit the next tile on the same line?

If set to false, a new line will only be started if a tile specifies tile.startLine or tile.endLine.

Returns:
Boolean

setDragDataAction

public void setDragDataAction(DragDataAction dragDataAction)
Indicates what to do with data dragged into another DataBoundComponent. See DragDataAction type for details.

Parameters:
dragDataAction - dragDataAction Default value is Canvas.MOVE

getDragDataAction

public DragDataAction getDragDataAction()
Indicates what to do with data dragged into another DataBoundComponent. See DragDataAction type for details.

Returns:
DragDataAction

getTile

public Canvas getTile(int index)
Retrieve a tile by index.

The TileLayout consistently uses this method to access tiles, in order to allow subclasses to create tiles on demand.

Parameters:
index - index of the tile
Returns:
the tile

addTile

public void addTile(Canvas tile)
Add a tile to the layout, dynamically.

Parameters:
tile - new tile to add

addTile

public void addTile(Canvas tile,
                    int index)
Add a tile to the layout, dynamically.

Parameters:
tile - new tile to add
index - position where the tile should be added. Defaults to adding the tile at the end.

setTiles

public void setTiles(Canvas... tiles)
              throws java.lang.IllegalStateException
List of tiles to lay out.

Parameters:
tiles - tiles Default value is null
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

setLayoutPolicy

public void setLayoutPolicy(TileLayoutPolicy layoutPolicy)
                     throws java.lang.IllegalStateException
Policy for laying out tiles. See TileLayoutPolicy for options.

Parameters:
layoutPolicy - layoutPolicy Default value is ""
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

removeTile

public boolean removeTile(int tileIndex)
Remove a tile from the layout.

Parameters:
tileIndex - index or String ID of the tile
Returns:
whether a tile was found and removed

removeTile

public boolean removeTile(java.lang.String tileID)
Remove a tile from the layout.

Parameters:
tileID - index or String ID of the tile
Returns:
whether a tile was found and removed

removeTile

public boolean removeTile(Canvas tile)
Remove a tile from the layout.

Parameters:
tile - index or String ID of the tile
Returns:
whether a tile was found and removed

layoutTiles

public void layoutTiles()
Forces layout out the tiles