Package com.xwiki.macros.tab.macro

Class TabGroupMacroParameters

java.lang.Object
com.xwiki.macros.tab.macro.TabGroupMacroParameters
public class TabGroupMacroParameters extends Object
Parameters for TabGroupMacro.
Since:
1.24.0
Version:
$Id: $

  • Constructor Details

    • TabGroupMacroParameters

      public TabGroupMacroParameters()

  • Method Details

    • getId

      public String getId()
      Returns:
      the id of the element.

    • setId

      public void setId(String id)
      Parameters:
      id - the id of the element.

    • getTabLocation

      public TabGroupMacroParameters.Location getTabLocation()
      Returns:
      the tabs location related to the macro content.

    • setTabLocation

      public void setTabLocation(TabGroupMacroParameters.Location tabLocation)
      Parameters:
      tabLocation - the tabs location related to the macro content.

    • getWidth

      public String getWidth()
      Returns:
      with of the macro.

    • setWidth

      public void setWidth(String width)
      Parameters:
      width - of the macro.

    • getHeight

      public String getHeight()
      Returns:
      height of the macro.

    • setHeight

      public void setHeight(String height)
      Parameters:
      height - height of the macro.

    • getCssClass

      public String getCssClass()
      Returns:
      the css class to add on the main element.

    • setCssClass

      public void setCssClass(String cssClass)
      Parameters:
      cssClass - the css class to add on the main element.

    • getNextAfter

      public int getNextAfter()
      Returns:
      The number of seconds the tab will stay visible before moving to the next one.

    • setNextAfter

      public void setNextAfter(int nextAfter)
      Parameters:
      nextAfter - The number of seconds the tab will stay visible before moving to the next one.

    • isLoopCards

      public boolean isLoopCards()
      Returns:
      If true, the tab will loop back to the beginning from the last tab.

    • setLoopCards

      public void setLoopCards(boolean loopCards)
      Parameters:
      loopCards - If true, the tab will loop back to the beginning from the last tab.

    • getEffectType

      public TransitionEffect getEffectType()
      Returns:
      The transition animation between each tab.

    • setEffectType

      public void setEffectType(TransitionEffect effectType)
      Parameters:
      effectType - The transition animation between each tab.

    • getEffectDuration

      public int getEffectDuration()
      Returns:
      The transition animation duration.

    • setEffectDuration

      public void setEffectDuration(int effectDuration)
      Parameters:
      effectDuration - The transition animation duration.