Package com.xwiki.macros.userlist.macro

Class UserListMacroParameters

java.lang.Object
com.xwiki.macros.userlist.macro.UserListMacroParameters
public class UserListMacroParameters extends Object
Parameters for the UserListMacro.
Version:
$Id$

  • Constructor Details

    • UserListMacroParameters

      public UserListMacroParameters()

  • Method Details

    • getUsers

      public com.xwiki.macros.internal.userlist.UserReferenceList getUsers()
      Returns:
      a list of users

    • setUsers

      public void setUsers(com.xwiki.macros.internal.userlist.UserReferenceList users)
      Sets a list of users.
      Parameters:
      users - list of user references

    • getGroups

      @Unstable public com.xwiki.macros.internal.grouplist.GroupReferenceList getGroups()
      Returns:
      a list of groups
      Since:
      1.6

    • setGroups

      @Unstable public void setGroups(com.xwiki.macros.internal.grouplist.GroupReferenceList groups)
      Sets a list of users.
      Parameters:
      groups - list of user references
      Since:
      1.6

    • getProperties

      public List<String> getProperties()
      Returns:
      list of properties to be displayed

    • setProperties

      public void setProperties(List<String> properties)
      Sets a list of property names.
      Parameters:
      properties - list of user properties

    • setFixedTableLayout

      public void setFixedTableLayout(boolean value)
      Sets the user list table layout style to "fixed".
      Parameters:
      value - true if the table layout should be fixed

    • isFixedTableLayout

      public boolean isFixedTableLayout()
      Returns:
      true if the user table should use a fixed layout