AnnouncementActionState.DisplayOptions (sakai-announcement-tool 10.3 API)

java.lang.Object
- org.sakaiproject.announcement.tool.AnnouncementActionState.DisplayOptions

Enclosing class:

AnnouncementActionState
```
public static class AnnouncementActionState.DisplayOptions
extends Object
```
Holds the display options for the Announcements tool

Constructor Summary

Constructors
Constructor and Description

AnnouncementActionState.DisplayOptions()
Default constructor

Constructors
Constructor and Description
`AnnouncementActionState.DisplayOptions()` Default constructor

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`getNumberOfAnnouncements()` Gets the number of announcements that we will show (if the limit is enabled).
`int`	`getNumberOfCharsPerAnnouncement()` Gets the number of characters that we will show in an announcement (if the limit is enabled).
`int`	`getNumberOfDaysInThePast()` Gets the number of days in the past for which we will show announcments (if the limit is enabled).
`static String`	`getVarNameEnforceNumberOfAnnouncementsLimit()` Gets a variable name for use in Velocity scripts to name input fields, etc.
`static String`	`getVarNameEnforceNumberOfCharsPerAnnouncementLimit()` Gets a variable name for use in Velocity scripts to name input fields, etc.
`static String`	`getVarNameEnforceNumberOfDaysInPastLimit()` Gets a variable name for use in Velocity scripts to name input fields, etc.
`static String`	`getVarNameNumberCharsPerAnnouncement()` Gets a variable name for use in Velocity scripts to name input fields, etc.
`static String`	`getVarNameNumberOfAnnouncements()` Gets a variable name for use in Velocity scripts to name input fields, etc.
`static String`	`getVarNameNumberOfDaysInPast()` Gets a variable name for use in Velocity scripts to name input fields, etc.
`static String`	`getVarNameShowAllColumns()` Gets a variable name for use in Velocity scripts to name input fields, etc.
`static String`	`getVarNameShowAnnouncementBody()` Gets a variable name for use in Velocity scripts to name input fields, etc.
`boolean`	`isEnforceNumberOfAnnouncementsLimit()` Returns true if we should limit the number of announcments shown.
`boolean`	`isEnforceNumberOfCharsPerAnnouncement()` Returns true if we should limit the number of characters per announcement.
`boolean`	`isEnforceNumberOfDaysInThePastLimit()` Returns true if we should limit the announcements displayed based on the number of days in the past on which the occurred.
`boolean`	`isShowAllColumns()` Gets whether or not we should show all the columns associated with the announcement.
`boolean`	`isShowAnnouncementBody()` Gets whether or not we should show the announcement body.
`boolean`	`isShowOnlyOptionsButton()`
`void`	`loadProperties(Map<?,?> params)` Loads properties from a map into our object.
`void`	`loadProperties(org.sakaiproject.util.ParameterParser parameters)` Loads properties from a ParameterParser object (usually gotten from a user's page submission).
`void`	`saveProperties(Properties resEdit)` Saves the properties in this object to a ResourcePropertiesEdit object.
`void`	`setEnforceNumberOfAnnouncementsLimit(boolean b)` Sets whether or not we should limit the number of announcements displayed.
`void`	`setEnforceNumberOfCharsPerAnnouncement(boolean b)` Sets whether or not we should limit the number of chars per announcement.
`void`	`setEnforceNumberOfDaysInThePastLimit(boolean b)` Sets whether or not we shoud limit the announcements displayed based on the number of days in the past on which they occurred.
`void`	`setNumberOfAnnouncements(int i)` Sets the limit on the number of announcements to show (if the limit is enabled).
`void`	`setNumberOfCharsPerAnnouncement(int i)` Sets the number of characters to show per announcement (if the limit is enabled).
`void`	`setNumberOfDaysInThePast(int i)` Sets the number of days in the past for which we will show announcments (if the limit is enabled).
`void`	`setShowAllColumns(boolean b)` Sets whether or not we should show all the columns associated with the announcement.
`void`	`setShowAnnouncementBody(boolean b)` Sets whether or not we should show the announcement body.
`void`	`setShowOnlyOptionsButton(boolean b)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AnnouncementActionState.DisplayOptions
```
public AnnouncementActionState.DisplayOptions()
```
    Default constructor
- Method Detail
  - getNumberOfAnnouncements
```
public int getNumberOfAnnouncements()
```
    Gets the number of announcements that we will show (if the limit is enabled).
  - getNumberOfCharsPerAnnouncement
```
public int getNumberOfCharsPerAnnouncement()
```
    Gets the number of characters that we will show in an announcement (if the limit is enabled).
  - getNumberOfDaysInThePast
```
public int getNumberOfDaysInThePast()
```
    Gets the number of days in the past for which we will show announcments (if the limit is enabled).
  - isShowAnnouncementBody
```
public boolean isShowAnnouncementBody()
```
    Gets whether or not we should show the announcement body.
  - isShowAllColumns
```
public boolean isShowAllColumns()
```
    Gets whether or not we should show all the columns associated with the announcement.
  - setNumberOfAnnouncements
```
public void setNumberOfAnnouncements(int i)
```
    Sets the limit on the number of announcements to show (if the limit is enabled).
  - setNumberOfCharsPerAnnouncement
```
public void setNumberOfCharsPerAnnouncement(int i)
```
    Sets the number of characters to show per announcement (if the limit is enabled).
  - setNumberOfDaysInThePast
```
public void setNumberOfDaysInThePast(int i)
```
    Sets the number of days in the past for which we will show announcments (if the limit is enabled).
  - setShowAnnouncementBody
```
public void setShowAnnouncementBody(boolean b)
```
    Sets whether or not we should show the announcement body.
  - setShowAllColumns
```
public void setShowAllColumns(boolean b)
```
    Sets whether or not we should show all the columns associated with the announcement.
  - isEnforceNumberOfAnnouncementsLimit
```
public boolean isEnforceNumberOfAnnouncementsLimit()
```
    Returns true if we should limit the number of announcments shown.
  - isEnforceNumberOfCharsPerAnnouncement
```
public boolean isEnforceNumberOfCharsPerAnnouncement()
```
    Returns true if we should limit the number of characters per announcement.
  - isEnforceNumberOfDaysInThePastLimit
```
public boolean isEnforceNumberOfDaysInThePastLimit()
```
    Returns true if we should limit the announcements displayed based on the number of days in the past on which the occurred.
  - setEnforceNumberOfAnnouncementsLimit
```
public void setEnforceNumberOfAnnouncementsLimit(boolean b)
```
    Sets whether or not we should limit the number of announcements displayed.
  - setEnforceNumberOfCharsPerAnnouncement
```
public void setEnforceNumberOfCharsPerAnnouncement(boolean b)
```
    Sets whether or not we should limit the number of chars per announcement.
  - setEnforceNumberOfDaysInThePastLimit
```
public void setEnforceNumberOfDaysInThePastLimit(boolean b)
```
    Sets whether or not we shoud limit the announcements displayed based on the number of days in the past on which they occurred.
  - loadProperties
```
public void loadProperties(Map<?,?> params)
```
    Loads properties from a map into our object.
  - loadProperties
```
public void loadProperties(org.sakaiproject.util.ParameterParser parameters)
```
    Loads properties from a ParameterParser object (usually gotten from a user's page submission).
  - saveProperties
```
public void saveProperties(Properties resEdit)
```
    Saves the properties in this object to a ResourcePropertiesEdit object.
  - getVarNameEnforceNumberOfAnnouncementsLimit
```
public static String getVarNameEnforceNumberOfAnnouncementsLimit()
```
    Gets a variable name for use in Velocity scripts to name input fields, etc.
  - getVarNameEnforceNumberOfDaysInPastLimit
```
public static String getVarNameEnforceNumberOfDaysInPastLimit()
```
    Gets a variable name for use in Velocity scripts to name input fields, etc.
  - getVarNameNumberCharsPerAnnouncement
```
public static String getVarNameNumberCharsPerAnnouncement()
```
    Gets a variable name for use in Velocity scripts to name input fields, etc.
  - getVarNameNumberOfAnnouncements
```
public static String getVarNameNumberOfAnnouncements()
```
    Gets a variable name for use in Velocity scripts to name input fields, etc.
  - getVarNameEnforceNumberOfCharsPerAnnouncementLimit
```
public static String getVarNameEnforceNumberOfCharsPerAnnouncementLimit()
```
    Gets a variable name for use in Velocity scripts to name input fields, etc.
  - getVarNameNumberOfDaysInPast
```
public static String getVarNameNumberOfDaysInPast()
```
    Gets a variable name for use in Velocity scripts to name input fields, etc.
  - getVarNameShowAllColumns
```
public static String getVarNameShowAllColumns()
```
    Gets a variable name for use in Velocity scripts to name input fields, etc.
  - getVarNameShowAnnouncementBody
```
public static String getVarNameShowAnnouncementBody()
```
    Gets a variable name for use in Velocity scripts to name input fields, etc.
  - isShowOnlyOptionsButton
```
public boolean isShowOnlyOptionsButton()
```
  - setShowOnlyOptionsButton
```
public void setShowOnlyOptionsButton(boolean b)
```

Class AnnouncementActionState.DisplayOptions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AnnouncementActionState.DisplayOptions

Method Detail

getNumberOfAnnouncements

getNumberOfCharsPerAnnouncement

getNumberOfDaysInThePast

isShowAnnouncementBody

isShowAllColumns

setNumberOfAnnouncements

setNumberOfCharsPerAnnouncement

setNumberOfDaysInThePast

setShowAnnouncementBody

setShowAllColumns

isEnforceNumberOfAnnouncementsLimit

isEnforceNumberOfCharsPerAnnouncement

isEnforceNumberOfDaysInThePastLimit

setEnforceNumberOfAnnouncementsLimit

setEnforceNumberOfCharsPerAnnouncement

setEnforceNumberOfDaysInThePastLimit

loadProperties

loadProperties

saveProperties

getVarNameEnforceNumberOfAnnouncementsLimit

getVarNameEnforceNumberOfDaysInPastLimit

getVarNameNumberCharsPerAnnouncement

getVarNameNumberOfAnnouncements

getVarNameEnforceNumberOfCharsPerAnnouncementLimit

getVarNameNumberOfDaysInPast

getVarNameShowAllColumns

getVarNameShowAnnouncementBody

isShowOnlyOptionsButton

setShowOnlyOptionsButton