com.aoindustries.website
Class Skin

java.lang.Object
  com.aoindustries.website.Skin

Direct Known Subclasses:

TextSkin

public abstract class Skin
extends java.lang.Object

One look-and-feel for the website.

Author:

AO Industries, Inc.

Nested Class Summary

static class

Skin.Language

Field Summary

static int	DOWN Directional references.
static int	NONE Directional references.
static int	UP Directional references.
static int	UP_AND_DOWN Directional references.

Constructor Summary

Skin()

Method Summary

abstract void	beginLightArea(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, javax.servlet.jsp.JspWriter out, java.lang.String width, boolean nowrap) Begins a light area.
abstract void	beginPopup(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, javax.servlet.jsp.JspWriter out, long groupId, long popupId, java.lang.String width) Begins a popup that is in a popup group.
abstract void	beginPopupGroup(javax.servlet.http.HttpServletRequest req, javax.servlet.jsp.JspWriter out, long groupId) Begins a popup group.
abstract void	beginWhiteArea(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, javax.servlet.jsp.JspWriter out, java.lang.String width, boolean nowrap) Begins a white area.
abstract void	endContent(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, javax.servlet.jsp.JspWriter out, PageAttributes pageAttributes, int[] colspans) Ends the content area of a page.
abstract void	endContentLine(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, javax.servlet.jsp.JspWriter out, int rowspan, boolean endsInternal) Ends one line of content.
abstract void	endLightArea(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, javax.servlet.jsp.JspWriter out) Ends a light area.
abstract void	endPopup(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, javax.servlet.jsp.JspWriter out, long groupId, long popupId, java.lang.String width) Ends a popup that is in a popup group.
abstract void	endPopupGroup(javax.servlet.http.HttpServletRequest req, javax.servlet.jsp.JspWriter out, long groupId) Ends a popup group.
abstract void	endSkin(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, javax.servlet.jsp.JspWriter out, PageAttributes pageAttributes) Writes the contents between the page content and the HTML tag (not including the HTML tag itself).
abstract void	endWhiteArea(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, javax.servlet.jsp.JspWriter out) Ends a white area.
static java.lang.String	getCharacterSet(java.util.Locale locale) Provides the correct character set for the given locale.
static java.lang.String	getDefaultHttpsUrlBase(javax.servlet.http.HttpServletRequest req) Gets the prefix for URLs for the SSL server.
static java.lang.String	getDefaultHttpUrlBase(javax.servlet.http.HttpServletRequest req) Gets the prefix for URLs for the non-SSL server.
abstract java.lang.String	getDisplay(javax.servlet.http.HttpServletRequest req) Gets the display value for this skin in the provided locale.
java.lang.String	getHttpsUrlBase(javax.servlet.http.HttpServletRequest req) Gets the prefix for URLs for the SSL server.
java.lang.String	getHttpUrlBase(javax.servlet.http.HttpServletRequest req) Gets the prefix for URLs for the non-SSL server.
abstract java.lang.String	getName() Gets the name of this skin.
abstract void	printAutoIndex(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, javax.servlet.jsp.JspWriter out, PageAttributes pageAttributes) Prints the auto index of all the page siblings.
abstract void	printContentHorizontalDivider(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, javax.servlet.jsp.JspWriter out, int[] colspansAndDirections, boolean endsInternal) Prints a horizontal divider of the provided colspans.
abstract void	printContentTitle(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, javax.servlet.jsp.JspWriter out, java.lang.String title, int colspan) Prints an entire content line including the provided title.
abstract void	printContentVerticalDivider(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, javax.servlet.jsp.JspWriter out, boolean visible, int colspan, int rowspan, java.lang.String align, java.lang.String width) Starts one line of content with the initial colspan set to the provided colspan.
abstract void	printPopupClose(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, javax.servlet.jsp.JspWriter out, long groupId, long popupId) Prints a popup close link/image/button for a popup that is part of a popup group.
abstract void	startContent(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, javax.servlet.jsp.JspWriter out, PageAttributes pageAttributes, int[] colspans, java.lang.String width) Starts the content area of a page.
abstract void	startContentLine(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, javax.servlet.jsp.JspWriter out, int colspan, java.lang.String align, java.lang.String width) Starts one line of content with the initial colspan set to the provided colspan.
abstract void	startSkin(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, javax.servlet.jsp.JspWriter out, PageAttributes pageAttributes) Writes the contents between the HTML tag and the page content (not including the HTML tag itself).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NONE

public static final int NONE

Directional references.

See Also:

Constant Field Values

UP

public static final int UP

Directional references.

See Also:

Constant Field Values

DOWN

public static final int DOWN

Directional references.

See Also:

Constant Field Values

UP_AND_DOWN

public static final int UP_AND_DOWN

Directional references.

See Also:

Constant Field Values

Constructor Detail

Skin

public Skin()

Method Detail

getCharacterSet

public static java.lang.String getCharacterSet(java.util.Locale locale)

Provides the correct character set for the given locale.

getName

public abstract java.lang.String getName()

Gets the name of this skin.

getDisplay

public abstract java.lang.String getDisplay(javax.servlet.http.HttpServletRequest req)
                                     throws javax.servlet.jsp.JspException

Gets the display value for this skin in the provided locale.

Throws:

javax.servlet.jsp.JspException

getDefaultHttpsUrlBase

public static java.lang.String getDefaultHttpsUrlBase(javax.servlet.http.HttpServletRequest req)
                                               throws javax.servlet.jsp.JspException

Gets the prefix for URLs for the SSL server. This should always end with a /.

Throws:

javax.servlet.jsp.JspException

getHttpsUrlBase

public java.lang.String getHttpsUrlBase(javax.servlet.http.HttpServletRequest req)
                                 throws javax.servlet.jsp.JspException

Gets the prefix for URLs for the SSL server. This should always end with a /.

Throws:

javax.servlet.jsp.JspException

getDefaultHttpUrlBase

public static java.lang.String getDefaultHttpUrlBase(javax.servlet.http.HttpServletRequest req)
                                              throws javax.servlet.jsp.JspException

Gets the prefix for URLs for the non-SSL server. This should always end with a /.

Throws:

javax.servlet.jsp.JspException

getHttpUrlBase

public java.lang.String getHttpUrlBase(javax.servlet.http.HttpServletRequest req)
                                throws javax.servlet.jsp.JspException

Gets the prefix for URLs for the non-SSL server. This should always end with a /.

Throws:

javax.servlet.jsp.JspException

startSkin

public abstract void startSkin(javax.servlet.http.HttpServletRequest req,
                               javax.servlet.http.HttpServletResponse resp,
                               javax.servlet.jsp.JspWriter out,
                               PageAttributes pageAttributes)
                        throws javax.servlet.jsp.JspException

Writes the contents between the HTML tag and the page content (not including the HTML tag itself).

Throws:

javax.servlet.jsp.JspException

startContent

public abstract void startContent(javax.servlet.http.HttpServletRequest req,
                                  javax.servlet.http.HttpServletResponse resp,
                                  javax.servlet.jsp.JspWriter out,
                                  PageAttributes pageAttributes,
                                  int[] colspans,
                                  java.lang.String width)
                           throws javax.servlet.jsp.JspException

Starts the content area of a page. The content area provides additional features such as a nice border, and vertical and horizontal dividers.

Throws:

javax.servlet.jsp.JspException

printContentTitle

public abstract void printContentTitle(javax.servlet.http.HttpServletRequest req,
                                       javax.servlet.http.HttpServletResponse resp,
                                       javax.servlet.jsp.JspWriter out,
                                       java.lang.String title,
                                       int colspan)
                                throws javax.servlet.jsp.JspException

Prints an entire content line including the provided title. The colspan should match the total colspan in startContent for proper appearance

Throws:

javax.servlet.jsp.JspException

startContentLine

public abstract void startContentLine(javax.servlet.http.HttpServletRequest req,
                                      javax.servlet.http.HttpServletResponse resp,
                                      javax.servlet.jsp.JspWriter out,
                                      int colspan,
                                      java.lang.String align,
                                      java.lang.String width)
                               throws javax.servlet.jsp.JspException

Starts one line of content with the initial colspan set to the provided colspan.

Throws:

javax.servlet.jsp.JspException

printContentVerticalDivider

public abstract void printContentVerticalDivider(javax.servlet.http.HttpServletRequest req,
                                                 javax.servlet.http.HttpServletResponse resp,
                                                 javax.servlet.jsp.JspWriter out,
                                                 boolean visible,
                                                 int colspan,
                                                 int rowspan,
                                                 java.lang.String align,
                                                 java.lang.String width)
                                          throws javax.servlet.jsp.JspException

Starts one line of content with the initial colspan set to the provided colspan.

Throws:

javax.servlet.jsp.JspException

endContentLine

public abstract void endContentLine(javax.servlet.http.HttpServletRequest req,
                                    javax.servlet.http.HttpServletResponse resp,
                                    javax.servlet.jsp.JspWriter out,
                                    int rowspan,
                                    boolean endsInternal)
                             throws javax.servlet.jsp.JspException

Ends one line of content.

Throws:

javax.servlet.jsp.JspException

printContentHorizontalDivider

public abstract void printContentHorizontalDivider(javax.servlet.http.HttpServletRequest req,
                                                   javax.servlet.http.HttpServletResponse resp,
                                                   javax.servlet.jsp.JspWriter out,
                                                   int[] colspansAndDirections,
                                                   boolean endsInternal)
                                            throws javax.servlet.jsp.JspException

Prints a horizontal divider of the provided colspans.

Throws:

javax.servlet.jsp.JspException

endContent

public abstract void endContent(javax.servlet.http.HttpServletRequest req,
                                javax.servlet.http.HttpServletResponse resp,
                                javax.servlet.jsp.JspWriter out,
                                PageAttributes pageAttributes,
                                int[] colspans)
                         throws javax.servlet.jsp.JspException

Ends the content area of a page.

Throws:

javax.servlet.jsp.JspException

endSkin

public abstract void endSkin(javax.servlet.http.HttpServletRequest req,
                             javax.servlet.http.HttpServletResponse resp,
                             javax.servlet.jsp.JspWriter out,
                             PageAttributes pageAttributes)
                      throws javax.servlet.jsp.JspException

Writes the contents between the page content and the HTML tag (not including the HTML tag itself).

Throws:

javax.servlet.jsp.JspException

beginLightArea

public abstract void beginLightArea(javax.servlet.http.HttpServletRequest req,
                                    javax.servlet.http.HttpServletResponse resp,
                                    javax.servlet.jsp.JspWriter out,
                                    java.lang.String width,
                                    boolean nowrap)
                             throws javax.servlet.jsp.JspException

Begins a light area.

Throws:

javax.servlet.jsp.JspException

endLightArea

public abstract void endLightArea(javax.servlet.http.HttpServletRequest req,
                                  javax.servlet.http.HttpServletResponse resp,
                                  javax.servlet.jsp.JspWriter out)
                           throws javax.servlet.jsp.JspException

Ends a light area.

Throws:

javax.servlet.jsp.JspException

beginWhiteArea

public abstract void beginWhiteArea(javax.servlet.http.HttpServletRequest req,
                                    javax.servlet.http.HttpServletResponse resp,
                                    javax.servlet.jsp.JspWriter out,
                                    java.lang.String width,
                                    boolean nowrap)
                             throws javax.servlet.jsp.JspException

Begins a white area.

Throws:

javax.servlet.jsp.JspException

endWhiteArea

public abstract void endWhiteArea(javax.servlet.http.HttpServletRequest req,
                                  javax.servlet.http.HttpServletResponse resp,
                                  javax.servlet.jsp.JspWriter out)
                           throws javax.servlet.jsp.JspException

Ends a white area.

Throws:

javax.servlet.jsp.JspException

printAutoIndex

public abstract void printAutoIndex(javax.servlet.http.HttpServletRequest req,
                                    javax.servlet.http.HttpServletResponse resp,
                                    javax.servlet.jsp.JspWriter out,
                                    PageAttributes pageAttributes)
                             throws javax.servlet.jsp.JspException

Prints the auto index of all the page siblings.

Throws:

javax.servlet.jsp.JspException

beginPopupGroup

public abstract void beginPopupGroup(javax.servlet.http.HttpServletRequest req,
                                     javax.servlet.jsp.JspWriter out,
                                     long groupId)
                              throws javax.servlet.jsp.JspException

Begins a popup group.

Throws:

javax.servlet.jsp.JspException

endPopupGroup

public abstract void endPopupGroup(javax.servlet.http.HttpServletRequest req,
                                   javax.servlet.jsp.JspWriter out,
                                   long groupId)
                            throws javax.servlet.jsp.JspException

Ends a popup group.

Throws:

javax.servlet.jsp.JspException

beginPopup

public abstract void beginPopup(javax.servlet.http.HttpServletRequest req,
                                javax.servlet.http.HttpServletResponse resp,
                                javax.servlet.jsp.JspWriter out,
                                long groupId,
                                long popupId,
                                java.lang.String width)
                         throws javax.servlet.jsp.JspException

Begins a popup that is in a popup group.

Throws:

javax.servlet.jsp.JspException

printPopupClose

public abstract void printPopupClose(javax.servlet.http.HttpServletRequest req,
                                     javax.servlet.http.HttpServletResponse resp,
                                     javax.servlet.jsp.JspWriter out,
                                     long groupId,
                                     long popupId)
                              throws javax.servlet.jsp.JspException

Prints a popup close link/image/button for a popup that is part of a popup group.

Throws:

javax.servlet.jsp.JspException

endPopup

public abstract void endPopup(javax.servlet.http.HttpServletRequest req,
                              javax.servlet.http.HttpServletResponse resp,
                              javax.servlet.jsp.JspWriter out,
                              long groupId,
                              long popupId,
                              java.lang.String width)
                       throws javax.servlet.jsp.JspException

Ends a popup that is in a popup group.

Throws:

javax.servlet.jsp.JspException