Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.renderer.filter.wiki.list
Class ListType

java.lang.Object
  extended by com.jivesoftware.forum.renderer.filter.wiki.list.ListType

public class ListType
extends java.lang.Object

Defines list types used for rendering lists.


Field Summary
static ListType BULLET
          Type representing a bulleted list
static ListType DASH
          Type representing a dashed list
static ListType NUMBER
          Type representing a numbered list
 
Method Summary
 char getBullet()
          Returns the bullet character for the list type
 java.lang.String getClosingTag()
          Returns the closing tag for the list type
static ListType getListType(char bullet)
          A helper method to get a specific ListType object from a bullet character
 java.lang.String getOpeningTag()
          Returns the opening tag for the list type
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

BULLET

public static final ListType BULLET
Type representing a bulleted list


NUMBER

public static final ListType NUMBER
Type representing a numbered list


DASH

public static final ListType DASH
Type representing a dashed list

Method Detail

getBullet

public char getBullet()
Returns the bullet character for the list type

Returns:
the bullet character for the list type

getOpeningTag

public java.lang.String getOpeningTag()
Returns the opening tag for the list type

Returns:
the opening tag for the list type

getClosingTag

public java.lang.String getClosingTag()
Returns the closing tag for the list type

Returns:
the closing tag for the list type

getListType

public static ListType getListType(char bullet)
A helper method to get a specific ListType object from a bullet character

Parameters:
bullet - the bullet for the list type
Returns:
the ListType object corresponding to the bullet. NULL if the bullet is invalid.

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.