Package org.opencms.gwt.client.ui

Interface I_CmsAutoHider

All Known Implementing Classes:
A_CmsListItemSelectDialog, A_CmsNewModelPageDialog, A_CmsUploadDialog, CmsAcceptDeclineCancelDialog, CmsAlertDialog, CmsAttributesDialog, CmsCategoryDialog, CmsConfirmDialog, CmsConfirmRemoveDialog, CmsConfirmSaveDialog, CmsContextMenu, CmsCopyLocaleDialog, CmsCopyModelPageDialog, CmsCreateGalleryDialog, CmsCreateModelPageDialog, CmsCreateModeSelectionDialog, CmsDeleteWarningDialog, CmsDroppedElementModeSelectionDialog, CmsEditExternalLinkDialog, CmsElementSettingsDialog, CmsErrorDialog, CmsFormDialog, CmsFramePopup, CmsGalleryPopup, CmsListAddDialog, CmsLockReportDialog, CmsModelSelectDialog, CmsOptionDialog, CmsPopup, CmsPreviewDialog, CmsPropertyDefinitionDialog, CmsPublishConfirmationDialog, CmsPublishDialog, CmsRemovedElementDeletionDialog, CmsRenameDialog, CmsReplaceDialog, CmsResourceInfoDialog, CmsRestoreDialog, CmsReuseInfoDialog, CmsSeoOptionsDialog, CmsSingleFileUploadDialog, CmsSubSitemapMenuEntry.SitemapTypeDialog, CmsToolbarPopup, CmsUploadDialogFileApiImpl, CmsUploadDialogFormDataImpl, CmsUploadDialogImpl, CmsUploadPopup, CmsUserSettingsDialog, CmsYesNoDialog
public interface I_CmsAutoHider
Interface for all widgets capable of auto hide.

Since:
8.0.0

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addAutoHidePartner(com.google.gwt.dom.client.Element partner)
    Mouse events that occur within an autoHide partner will not hide a panel set to autoHide.
    void
    hide()
    Hides the widget.
    boolean
    isAutoHideEnabled()
    Returns if the auto hide feature is enabled.
    boolean
    isAutoHideOnHistoryEventsEnabled()
    Returns if the auto hide on history event feature is enabled.
    void
    removeAutoHidePartner(com.google.gwt.dom.client.Element partner)
    Removes an auto-hide partner.
    void
    setAutoHideEnabled(boolean autoHide)
    Enable or disable the autoHide feature.
    void
    setAutoHideOnHistoryEventsEnabled(boolean enabled)
    Enable or disable autoHide on history change events.

  • Method Details

    • addAutoHidePartner

      void addAutoHidePartner(com.google.gwt.dom.client.Element partner)
      Mouse events that occur within an autoHide partner will not hide a panel set to autoHide.

      Parameters:
      partner - the auto hide partner to add
      See Also:
      • PopupPanel.addAutoHidePartner(com.google.gwt.dom.client.Element)

    • hide

      void hide()
      Hides the widget.

    • isAutoHideEnabled

      boolean isAutoHideEnabled()
      Returns if the auto hide feature is enabled.

      Returns:
      true if auto hide is enabled
      See Also:
      • PopupPanel.isAutoHideEnabled()

    • isAutoHideOnHistoryEventsEnabled

      boolean isAutoHideOnHistoryEventsEnabled()
      Returns if the auto hide on history event feature is enabled.

      Returns:
      true if auto hide is enabled
      See Also:
      • PopupPanel.isAutoHideOnHistoryEventsEnabled()

    • removeAutoHidePartner

      void removeAutoHidePartner(com.google.gwt.dom.client.Element partner)
      Removes an auto-hide partner.

      Parameters:
      partner - the auto-hide partner to remove
      See Also:
      • PopupPanel.removeAutoHidePartner(Element)

    • setAutoHideEnabled

      void setAutoHideEnabled(boolean autoHide)
      Enable or disable the autoHide feature. When enabled, the popup will be automatically hidden when the user clicks outside of it.

      Parameters:
      autoHide - enable true to enable, false to disable
      See Also:
      • PopupPanel.setAutoHideEnabled(boolean)

    • setAutoHideOnHistoryEventsEnabled

      void setAutoHideOnHistoryEventsEnabled(boolean enabled)
      Enable or disable autoHide on history change events. When enabled, the popup will be automatically hidden when the history token changes, such as when the user presses the browser's back button. Disabled by default.

      Parameters:
      enabled - enable true to enable, false to disable
      See Also:
      • PopupPanel.setAutoHideOnHistoryEventsEnabled(boolean)