Package com.smartgwt.client.widgets.layout

Class Portlet

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.layout.Layout
com.smartgwt.client.widgets.layout.VLayout
com.smartgwt.client.widgets.Window
com.smartgwt.client.widgets.layout.Portlet
All Implemented Interfaces:
HasAttachHandlers, HasHandlers, EventListener, HasVisibility, IsWidget, LogicalStructure, HasClearHandlers, HasClickHandlers, HasCloseClickHandlers, HasDoubleClickHandlers, HasDragMoveHandlers, HasDragRepositionMoveHandlers, HasDragRepositionStartHandlers, HasDragRepositionStopHandlers, HasDragResizeMoveHandlers, HasDragResizeStartHandlers, HasDragResizeStopHandlers, HasDragStartHandlers, HasDragStopHandlers, HasDropHandlers, HasDropMoveHandlers, HasDropOutHandlers, HasDropOverHandlers, HasFocusChangedHandlers, HasHoverHandlers, HasHoverHiddenHandlers, HasKeyDownHandlers, HasKeyPressHandlers, HasMaximizeClickHandlers, HasMinimizeClickHandlers, HasMouseDownHandlers, HasMouseMoveHandlers, HasMouseOutHandlers, HasMouseOverHandlers, HasMouseStillDownHandlers, HasMouseUpHandlers, HasMouseWheelHandlers, HasMovedHandlers, HasParentMovedHandlers, HasResizedHandlers, HasRestoreClickHandlers, HasRightMouseDownHandlers, HasRuleContextChangedHandlers, HasScrolledHandlers, HasShowContextMenuHandlers, HasVisibilityChangedHandlers, HasMembersChangedHandlers
public class Portlet extends Window
Custom subclass of Window configured to be embedded within a PortalLayout.

  • Constructor Details

  • Method Details

    • getOrCreateRef

      public static Portlet getOrCreateRef(JavaScriptObject jsObj)

    • changeAutoChildDefaults

      public static void changeAutoChildDefaults(String autoChildName, Canvas defaults)
      Changes the defaults for Canvas AutoChildren named autoChildName.
      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, see SGWTProperties.
      See Also:

    • changeAutoChildDefaults

      public static void changeAutoChildDefaults(String autoChildName, FormItem defaults)
      Changes the defaults for FormItem AutoChildren named autoChildName.
      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, see SGWTProperties.
      See Also:

    • create

      protected JavaScriptObject create()
      Overrides:
      create in class Window

    • setCloseConfirmationDialogProperties

      public Portlet setCloseConfirmationDialogProperties(Dialog closeConfirmationDialogProperties)
      If specified, this properties block will be passed to SC.confirm() as the properties parameter when the closeConfirmationMessage is shown, allowing developers to customize the appear of the confirmation dialog (modifying its title, etc).
      Parameters:
      closeConfirmationDialogProperties - New closeConfirmationDialogProperties value. Default value is null
      Returns:
      Portlet instance, for chaining setter calls
      See Also:

    • getCloseConfirmationDialogProperties

      public Dialog getCloseConfirmationDialogProperties()
      If specified, this properties block will be passed to SC.confirm() as the properties parameter when the closeConfirmationMessage is shown, allowing developers to customize the appear of the confirmation dialog (modifying its title, etc).
      Returns:
      Current closeConfirmationDialogProperties value. Default value is null

    • setCloseConfirmationMessage

      public Portlet setCloseConfirmationMessage(String closeConfirmationMessage)
      Confirmation message to show the user when closing portlets if showCloseConfirmationMessage is true.
      Parameters:
      closeConfirmationMessage - New closeConfirmationMessage value. Default value is "Close portlet?"
      Returns:
      Portlet instance, for chaining setter calls

    • getCloseConfirmationMessage

      public String getCloseConfirmationMessage()
      Confirmation message to show the user when closing portlets if showCloseConfirmationMessage is true.
      Returns:
      Current closeConfirmationMessage value. Default value is "Close portlet?"

    • setDestroyOnClose

      public Portlet setDestroyOnClose(Boolean destroyOnClose)
      Whether to call destroy() when closing the Portlet.
      Parameters:
      destroyOnClose - New destroyOnClose value. Default value is false
      Returns:
      Portlet instance, for chaining setter calls

    • getDestroyOnClose

      public Boolean getDestroyOnClose()
      Whether to call destroy() when closing the Portlet.
      Returns:
      Current destroyOnClose value. Default value is false

    • setEditProxyConstructor

      public Portlet setEditProxyConstructor(String editProxyConstructor) throws IllegalStateException
      Default class used to construct the EditProxy for this component when the component is first placed into edit mode.
      Overrides:
      setEditProxyConstructor in class Window
      Parameters:
      editProxyConstructor - New editProxyConstructor value. Default value is "PortletEditProxy"
      Returns:
      Portlet instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
      See Also:

    • getEditProxyConstructor

      public String getEditProxyConstructor()
      Default class used to construct the EditProxy for this component when the component is first placed into edit mode.
      Overrides:
      getEditProxyConstructor in class Window
      Returns:
      Current editProxyConstructor value. Default value is "PortletEditProxy"
      See Also:

    • setMinHeight

      public Portlet setMinHeight(int minHeight)
      Specifies a minimum height for the Portlet. The height of rows within a PortalLayout will be adjusted to take into account the minHeight of all the Portlets in that row.
      Overrides:
      setMinHeight in class Canvas
      Parameters:
      minHeight - New minHeight value. Default value is 60
      Returns:
      Portlet instance, for chaining setter calls
      See Also:

    • getMinHeight

      public int getMinHeight()
      Specifies a minimum height for the Portlet. The height of rows within a PortalLayout will be adjusted to take into account the minHeight of all the Portlets in that row.
      Overrides:
      getMinHeight in class Canvas
      Returns:
      Current minHeight value. Default value is 60
      See Also:

    • setMinWidth

      public Portlet setMinWidth(int minWidth)
      Specifies a minimum width for the Portlet.
      Overrides:
      setMinWidth in class Canvas
      Parameters:
      minWidth - New minWidth value. Default value is 70
      Returns:
      Portlet instance, for chaining setter calls
      See Also:

    • getMinWidth

      public int getMinWidth()
      Specifies a minimum width for the Portlet.
      Overrides:
      getMinWidth in class Canvas
      Returns:
      Current minWidth value. Default value is 70
      See Also:

    • setShowCloseConfirmationMessage

      public Portlet setShowCloseConfirmationMessage(Boolean showCloseConfirmationMessage)
      If true, closeConfirmationMessage will be displayed before portlets are closed
      Parameters:
      showCloseConfirmationMessage - New showCloseConfirmationMessage value. Default value is true
      Returns:
      Portlet instance, for chaining setter calls

    • getShowCloseConfirmationMessage

      public Boolean getShowCloseConfirmationMessage()
      If true, closeConfirmationMessage will be displayed before portlets are closed
      Returns:
      Current showCloseConfirmationMessage value. Default value is true

    • close

      public void close()
      close() method overridden to show closeConfirmationMessage to the user before removing the portlet from the PortalLayout via PortalLayout.removePortlet()
      Overrides:
      close in class Window

    • closeClick

      public Boolean closeClick()
      Handles a click on the close button of this portlet. The default implementation calls close().

      Developers may use addCloseClickHandler() to provide custom handling when the user clicks this button. Custom implementations may call close() to trigger the default behavior.

      Returns:
      Return false to cancel bubbling the click event

    • getPortalLayout

      public PortalLayout getPortalLayout()
      Gets the PortalLayout which encloses this Portlet (or null, if none).
      Returns:
      the PortalLayout enclosing this Portlet

    • getPortalPosition

      public PortalPosition getPortalPosition()
      Gets the position of the Portlet within its PortalLayout. Returns null if the Portlet is not in a PortalLayout.
      Returns:
      the position of the Portlet

    • setDefaultProperties

      public static void setDefaultProperties(Portlet portletProperties)
      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:
      portletProperties - properties that should be used as new defaults when instances of this class are created
      See Also:

    • setRowHeight

      public void setRowHeight(int rowHeight)
      If you set the rowHeight of a Portlet before adding it to a PortalLayout, then the height will be used when creating the new row. If adding the Portlet to an existing row (or dragging it there), the Portlet's rowHeight will be used if the row's height has not already been specified. However, if you set the rowHeight of a Portlet after adding it to the PortalLayout, then the height of the entire row will always be adjusted to match.

      You can also just specify height when initializing a Portlet, and it will be applied to the rowHeight when added to a PortalLayout. However, changing the Portlet's height after initialization will not affect the row.

      Note that getting the rowHeight will indicate the rowHeight specified for this Portlet, not the actual height of the row it is in.

      Parameters:
      rowHeight - rowHeight Default value is null

    • getRowHeight

      public Integer getRowHeight()
      If you set the rowHeight of a Portlet before adding it to a PortalLayout, then the height will be used when creating the new row. If adding the Portlet to an existing row (or dragging it there), the Portlet's rowHeight will be used if the row's height has not already been specified. However, if you set the rowHeight of a Portlet after adding it to the PortalLayout, then the height of the entire row will always be adjusted to match.

      You can also just specify height when initializing a Portlet, and it will be applied to the rowHeight when added to a PortalLayout. However, changing the Portlet's height after initialization will not affect the row.

      Note that getting the rowHeight will indicate the rowHeight specified for this Portlet, not the actual height of the row it is in.

      Returns:
      Integer

    • setRowHeight

      public void setRowHeight(String rowHeight)
      If you set the rowHeight of a Portlet before adding it to a PortalLayout, then the height will be used when creating the new row. If adding the Portlet to an existing row (or dragging it there), the Portlet's rowHeight will be used if the row's height has not already been specified. However, if you set the rowHeight of a Portlet after adding it to the PortalLayout, then the height of the entire row will always be adjusted to match.

      You can also just specify height when initializing a Portlet, and it will be applied to the rowHeight when added to a PortalLayout. However, changing the Portlet's height after initialization will not affect the row.

      Note that getting the rowHeight will indicate the rowHeight specified for this Portlet, not the actual height of the row it is in.

      Parameters:
      rowHeight - rowHeight Default value is null

    • getRowHeightAsString

      public String getRowHeightAsString()
      If you set the rowHeight of a Portlet before adding it to a PortalLayout, then the height will be used when creating the new row. If adding the Portlet to an existing row (or dragging it there), the Portlet's rowHeight will be used if the row's height has not already been specified. However, if you set the rowHeight of a Portlet after adding it to the PortalLayout, then the height of the entire row will always be adjusted to match.

      You can also just specify height when initializing a Portlet, and it will be applied to the rowHeight when added to a PortalLayout. However, changing the Portlet's height after initialization will not affect the row.

      Note that getting the rowHeight will indicate the rowHeight specified for this Portlet, not the actual height of the row it is in.

      Returns:
      String

    • setHeight

      public Portlet setHeight(int height)
      If you set the height of a Portlet, then that height will be used as the Portlet's rowHeight (if no rowHeight is set).

      After initialization, the PortalLayout manages the height of Portlets. If you want to change the height, use com.smartgwt.client.widgets.layout.PortalLayout#setRowHeight.

      Overrides:
      setHeight in class Canvas
      Parameters:
      height - height Default value is null
      See Also:

    • getHeight

      public Integer getHeight()
      If you set the height of a Portlet, then that height will be used as the Portlet's rowHeight (if no rowHeight is set).

      After initialization, the PortalLayout manages the height of Portlets. If you want to change the height, use com.smartgwt.client.widgets.layout.PortalLayout#setRowHeight.

      Overrides:
      getHeight in class Canvas
      Returns:
      Integer
      See Also:

    • setHeight

      public void setHeight(String height)
      If you set the height of a Portlet, then that height will be used as the Portlet's rowHeight (if no rowHeight is set).

      After initialization, the PortalLayout manages the height of Portlets. If you want to change the height, use com.smartgwt.client.widgets.layout.PortalLayout#setRowHeight.

      Overrides:
      setHeight in class Canvas
      Parameters:
      height - height Default value is null
      See Also:

    • getHeightAsString

      public String getHeightAsString()
      If you set the height of a Portlet, then that height will be used as the Portlet's rowHeight (if no rowHeight is set).

      After initialization, the PortalLayout manages the height of Portlets. If you want to change the height, use com.smartgwt.client.widgets.layout.PortalLayout#setRowHeight.

      Overrides:
      getHeightAsString in class Canvas
      Returns:
      String

    • setLogicalStructure

      public LogicalStructureObject setLogicalStructure(PortletLogicalStructure s)
      Setter implementing the LogicalStructure interface, which supports Eclipse's logical structure debugging facility.

    • getLogicalStructure

      public LogicalStructureObject getLogicalStructure()
      Getter implementing the LogicalStructure interface, which supports Eclipse's logical structure debugging facility.
      Specified by:
      getLogicalStructure in interface LogicalStructure
      Overrides:
      getLogicalStructure in class Window