org.openxava.web.style
Class Style

java.lang.Object
  org.openxava.web.style.Style

Direct Known Subclasses:

IPadStyle, PortalStyle

public class Style
extends java.lang.Object

This class and its subclasses is used from JSP code to give style to the web applications.

The nomenclature is:

• By default: CSS class name.
• ..Style: A CSS inline style.
• ..Image: URI of image
• ..Events: code for javascript events
• ..StartDecoration/EndDecoration: HTML code to put before and after.
• ..Spacing: Table spacing

Author:

Javier Paniza

Constructor Summary

Style()

Method Summary

boolean	allowsResizeColumns()
protected java.util.Collection<java.lang.String>	createAdditionalCssFiles()
java.lang.String	getActionImage()
java.lang.String	getActionLink()
java.lang.String	getActive()
java.lang.String	getActiveSection()
java.lang.String	getActiveSectionTabEndDecoration()
java.lang.String	getActiveSectionTabStartDecoration(boolean first, boolean last)
java.util.Collection<java.lang.String>	getAdditionalCssFiles() These css files will be always added, inside and outside portal.
java.lang.String	getAscending2Image()
java.lang.String	getAscendingImage()
java.lang.String	getBottomButtons()
java.lang.String	getBottomButtonsStyle()
java.lang.String	getBrowser()
java.lang.String	getButton()
java.lang.String	getButtonBar()
java.lang.String	getButtonBarButton()
java.lang.String	getButtonBarImage()
java.lang.String	getButtonBarModeButton()
java.lang.String	getCollectionListActions()
java.lang.String	getCoreEndDecoration()
java.lang.String	getCoreStartDecoration()
java.lang.String	getCssFile()
java.lang.String	getCurrentRow()
java.lang.String	getCurrentRowCell()
java.lang.String	getDefaultModeController()
java.lang.String	getDescending2Image()
java.lang.String	getDescendingImage()
java.lang.String	getDetail()
java.lang.String	getEditor()
java.lang.String	getEditorWrapper()
java.lang.String	getErrorEndDecoration()
java.lang.String	getErrors()
java.lang.String	getErrorStartDecoration()
java.lang.String	getFilterCell()
java.lang.String	getFirst()
protected java.lang.String	getFrame()
java.lang.String	getFrameActions()
java.lang.String	getFrameActionsEndDecoration()
java.lang.String	getFrameActionsStartDecoration()
protected java.lang.String	getFrameContent()
java.lang.String	getFrameContentEndDecoration()
java.lang.String	getFrameContentStartDecoration()
java.lang.String	getFrameContentStartDecoration(java.lang.String id, boolean closed)
java.lang.String	getFrameHeaderEndDecoration()
java.lang.String	getFrameHeaderStartDecoration()
java.lang.String	getFrameHeaderStartDecoration(int width)
protected java.lang.String	getFrameSpacing()
protected java.lang.String	getFrameTitle()
java.lang.String	getFrameTitleEndDecoration()
protected java.lang.String	getFrameTitleLabel()
java.lang.String	getFrameTitleStartDecoration()
java.lang.String	getFrameTotals()
java.lang.String	getFrameTotalsLabel()
java.lang.String	getFrameTotalsValue()
java.lang.String	getFrameWidth()
java.lang.String	getHeaderListCount()
java.lang.String	getHelp() CSS class for the help icon, link or button.
java.lang.String	getHelpImage()
java.lang.String	getImagesFolder() The folder with images used for actions.
java.lang.String	getInfos()
java.lang.String	getInitThemeScript()
static Style	getInstance()
static Style	getInstance(HttpServletRequest request)
protected java.lang.String	getJQueryCss()
java.lang.String	getLabel()
java.lang.String	getLast()
java.lang.String	getList()
java.lang.String	getListCellSpacing()
java.lang.String	getListCellStyle()
java.lang.String	getListHeader()
java.lang.String	getListHeaderCell()
java.lang.String	getListInfo()
java.lang.String	getListInfoDetail()
java.lang.String	getListOdd()
java.lang.String	getListOddCell()
java.lang.String	getListOddEvents()
java.lang.String	getListOddSelected()
java.lang.String	getListOrderBy()
java.lang.String	getListPair()
java.lang.String	getListPairCell()
java.lang.String	getListPairEvents()
java.lang.String	getListPairSelected()
java.lang.String	getListStyle()
java.lang.String	getListSubheader()
java.lang.String	getListSubheaderCell()
java.lang.String	getListTitle()
java.lang.String	getListTitleWrapper()
java.lang.String	getLoadingImage()
java.lang.String	getMaximizeImage() If it starts with '/' the URI is absolute, otherwise the context path is inserted before.
java.lang.String	getMessageEndDecoration()
java.lang.String	getMessages()
java.lang.String	getMessageStartDecoration()
java.lang.String	getMessagesWrapper() For messages and errors
java.lang.String	getMetaTags()
java.lang.String	getMinimizeImage() If it starts with '/' the URI is absolute, otherwise the context path is inserted before.
java.lang.String	getModule()
java.lang.String	getModuleDescription()
java.lang.String	getModuleSpacing()
java.lang.String	getNextPageDisableImage()
java.lang.String	getNextPageNavigationEvents(java.lang.String listId)
java.lang.String	getNoPortalModuleEndDecoration()
java.lang.String[]	getNoPortalModuleJsFiles()
java.lang.String	getNoPortalModuleStartDecoration(java.lang.String title)
java.lang.String	getPageNavigation()
java.lang.String	getPageNavigationArrow()
java.lang.String	getPageNavigationArrowDisable()
java.lang.String	getPageNavigationImage()
java.lang.String	getPageNavigationPages()
java.lang.String	getPageNavigationSelected()
java.lang.String	getPageNavigationSelectedImage()
java.lang.String	getPreviousPageDisableImage()
java.lang.String	getPreviousPageNavigationEvents(java.lang.String listId)
java.lang.String	getProcessing()
java.lang.String	getRemoveImage() If it starts with '/' the URI is absolute, otherwise the context path is inserted before.
java.lang.String	getRestoreImage() If it starts with '/' the URI is absolute, otherwise the context path is inserted before.
java.lang.String	getRowsPerPage()
java.lang.String	getSection()
java.lang.String	getSectionBarEndDecoration()
java.lang.String	getSectionBarStartDecoration()
java.lang.String	getSectionLink()
java.lang.String	getSectionLinkStyle()
java.lang.String	getSectionTab()
java.lang.String	getSectionTabEndDecoration()
java.lang.String	getSectionTableAttributes()
java.lang.String	getSectionTabStartDecoration(boolean first, boolean last)
protected java.lang.String	getSectionTabStartDecoration(boolean first, boolean last, boolean active)
java.lang.String	getSelectedRow()
java.lang.String	getSelectedRowStyle()
java.lang.String	getSetHtmlFunction() The JavaScript function that assign the HTML token to a specific a element.
java.lang.String	getSmallLabel()
java.lang.String	getTotalCapableCell()
java.lang.String	getTotalCapableCellStyle()
java.lang.String	getTotalCell()
java.lang.String	getTotalCellStyle()
java.lang.String	getTotalEmptyCellStyle()
java.lang.String	getTotalLabelCellStyle()
java.lang.String	getTotalRow()
java.lang.String	getView()
java.lang.String	getWarnings()
boolean	isAlignHeaderAsData() If true
boolean	isApplySelectedStyleToCellInList() If true the style for selected row (or special style) in a list is applied to the row (tr) and to also the cell (td).
boolean	isChangingPageRowCountAllowed()
protected boolean	isFirefox()
boolean	isFixedPositionSupported()
boolean	isForBrowse(java.lang.String browser) If this style is specific for the indicated browser.
boolean	isHelpAvailable()
boolean	isHideRowsAllowed()
protected boolean	isIE6()
protected boolean	isIE7()
boolean	isInsidePortal()
boolean	isNeededToIncludeCalendar()
boolean	isOnlyOneButtonForModeIfTwoModes()
boolean	isRowLinkable()
boolean	isSeparatorBeforeBottomButtons()
boolean	isSeveralActionsPerRow()
boolean	isShowImageInButtonBarButton()
boolean	isShowModuleDescription()
boolean	isShowPageNumber()
boolean	isShowRowCountOnTop()
boolean	isUseLinkForNoButtonBarAction()
boolean	isUseStandardImageActionForOnlyImageActionOnButtonBar() If true an image is shown using this value as class, otherwise the image would be shown as the background of a span with the getButtonBarButton() class.
void	setBrowser(java.lang.String browser)
void	setInsidePortal(boolean insidePortal)
static void	setPotalInstance(Style style)

Methods inherited from class java.lang.Object

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

Constructor Detail

Style

public Style()

Method Detail

getInstance

public static Style getInstance(HttpServletRequest request)

Since:

4.2

getInstance

public static Style getInstance()

setPotalInstance

public static void setPotalInstance(Style style)

Since:

4.2

getDefaultModeController

public java.lang.String getDefaultModeController()

Since:

4.2

isForBrowse

public boolean isForBrowse(java.lang.String browser)

If this style is specific for the indicated browser.

Since:

4.2

isOnlyOneButtonForModeIfTwoModes

public boolean isOnlyOneButtonForModeIfTwoModes()

Since:

4.2

getNoPortalModuleJsFiles

public java.lang.String[] getNoPortalModuleJsFiles()

getJQueryCss

protected java.lang.String getJQueryCss()

createAdditionalCssFiles

protected java.util.Collection<java.lang.String> createAdditionalCssFiles()

getAdditionalCssFiles

public final java.util.Collection<java.lang.String> getAdditionalCssFiles()

These css files will be always added, inside and outside portal.

To refine it overwrite the createAdditionalCssFiles() method.

getSetHtmlFunction

public java.lang.String getSetHtmlFunction()

The JavaScript function that assign the HTML token to a specific a element.

Since:

4.2

allowsResizeColumns

public boolean allowsResizeColumns()

Since:

4.2

getInitThemeScript

public java.lang.String getInitThemeScript()

getNoPortalModuleStartDecoration

public java.lang.String getNoPortalModuleStartDecoration(java.lang.String title)

getNoPortalModuleEndDecoration

public java.lang.String getNoPortalModuleEndDecoration()

getCoreStartDecoration

public java.lang.String getCoreStartDecoration()

Since:

4.2

getCoreEndDecoration

public java.lang.String getCoreEndDecoration()

Since:

4.2

getCssFile

public java.lang.String getCssFile()

getMetaTags

public java.lang.String getMetaTags()

Since:

4.2

getEditorWrapper

public java.lang.String getEditorWrapper()

getImagesFolder

public java.lang.String getImagesFolder()

The folder with images used for actions.

If it starts with / is absolute, otherwise starts from the application context path.

Since:

4.2

getPreviousPageDisableImage

public java.lang.String getPreviousPageDisableImage()

Since:

4.2

getNextPageDisableImage

public java.lang.String getNextPageDisableImage()

Since:

4.2

getPageNavigationSelectedImage

public java.lang.String getPageNavigationSelectedImage()

Since:

4.2

getPageNavigationImage

public java.lang.String getPageNavigationImage()

Since:

4.2

getModule

public java.lang.String getModule()

getView

public java.lang.String getView()

Since:

4.2

getDetail

public java.lang.String getDetail()

getModuleSpacing

public java.lang.String getModuleSpacing()

getActionLink

public java.lang.String getActionLink()

getActionImage

public java.lang.String getActionImage()

getButtonBar

public java.lang.String getButtonBar()

getButtonBarButton

public java.lang.String getButtonBarButton()

isSeveralActionsPerRow

public boolean isSeveralActionsPerRow()

isUseLinkForNoButtonBarAction

public boolean isUseLinkForNoButtonBarAction()

Since:

4.2

isUseStandardImageActionForOnlyImageActionOnButtonBar

public boolean isUseStandardImageActionForOnlyImageActionOnButtonBar()

If true an image is shown using this value as class, otherwise the image would be shown as the background of a span with the getButtonBarButton() class.

Since:

4.2

isSeparatorBeforeBottomButtons

public boolean isSeparatorBeforeBottomButtons()

Since:

4.2

getButtonBarImage

public java.lang.String getButtonBarImage()

Since:

4.2

getButtonBarModeButton

public java.lang.String getButtonBarModeButton()

getActive

public java.lang.String getActive()

Since:

4.2

getFirst

public java.lang.String getFirst()

Since:

4.2

getLast

public java.lang.String getLast()

Since:

4.2

getLabel

public java.lang.String getLabel()

getModuleDescription

public java.lang.String getModuleDescription()

Since:

4.2

getFrameContent

protected java.lang.String getFrameContent()

getList

public java.lang.String getList()

getListCellSpacing

public java.lang.String getListCellSpacing()

getListStyle

public java.lang.String getListStyle()

getListCellStyle

public java.lang.String getListCellStyle()

getListHeader

public java.lang.String getListHeader()

getListHeaderCell

public java.lang.String getListHeaderCell()

getListSubheader

public java.lang.String getListSubheader()

getListSubheaderCell

public java.lang.String getListSubheaderCell()

getListOrderBy

public java.lang.String getListOrderBy()

getListPair

public java.lang.String getListPair()

getListPairEvents

public java.lang.String getListPairEvents()

Parameters:

Since - v4m5 it has no parameters

getListPairCell

public java.lang.String getListPairCell()

getListOdd

public java.lang.String getListOdd()

getListOddEvents

public java.lang.String getListOddEvents()

Parameters:

Since - v4m5 it has no parameters

getListOddCell

public java.lang.String getListOddCell()

getListPairSelected

public java.lang.String getListPairSelected()

getListOddSelected

public java.lang.String getListOddSelected()

getListInfo

public java.lang.String getListInfo()

getListInfoDetail

public java.lang.String getListInfoDetail()

getListTitle

public java.lang.String getListTitle()

getHeaderListCount

public java.lang.String getHeaderListCount()

Since:

4.2

getListTitleWrapper

public java.lang.String getListTitleWrapper()

getFrameWidth

public java.lang.String getFrameWidth()

Since:

4.4

getFrameHeaderStartDecoration

public java.lang.String getFrameHeaderStartDecoration()

getFrameHeaderStartDecoration

public java.lang.String getFrameHeaderStartDecoration(int width)

getFrameHeaderEndDecoration

public java.lang.String getFrameHeaderEndDecoration()

getFrameTitleStartDecoration

public java.lang.String getFrameTitleStartDecoration()

getFrameTitleEndDecoration

public java.lang.String getFrameTitleEndDecoration()

getFrameActions

public java.lang.String getFrameActions()

Since:

4.2

getFrameActionsStartDecoration

public java.lang.String getFrameActionsStartDecoration()

getFrameActionsEndDecoration

public java.lang.String getFrameActionsEndDecoration()

getFrameTotals

public java.lang.String getFrameTotals()

Since:

4.4

getFrameTotalsLabel

public java.lang.String getFrameTotalsLabel()

Since:

4.4

getFrameTotalsValue

public java.lang.String getFrameTotalsValue()

Since:

4.4

getFrameContentStartDecoration

public java.lang.String getFrameContentStartDecoration()

getFrameContentStartDecoration

public java.lang.String getFrameContentStartDecoration(java.lang.String id,
                                                       boolean closed)

getFrameContentEndDecoration

public java.lang.String getFrameContentEndDecoration()

getFrame

protected java.lang.String getFrame()

getFrameTitle

protected java.lang.String getFrameTitle()

getFrameTitleLabel

protected java.lang.String getFrameTitleLabel()

getFrameSpacing

protected java.lang.String getFrameSpacing()

getEditor

public java.lang.String getEditor()

getSmallLabel

public java.lang.String getSmallLabel()

getErrors

public java.lang.String getErrors()

getMessages

public java.lang.String getMessages()

getInfos

public java.lang.String getInfos()

Since:

4.3

getWarnings

public java.lang.String getWarnings()

Since:

4.3

getErrorStartDecoration

public java.lang.String getErrorStartDecoration()

getErrorEndDecoration

public java.lang.String getErrorEndDecoration()

getMessagesWrapper

public java.lang.String getMessagesWrapper()

For messages and errors

getMessageStartDecoration

public java.lang.String getMessageStartDecoration()

getMessageEndDecoration

public java.lang.String getMessageEndDecoration()

getProcessing

public java.lang.String getProcessing()

getButton

public java.lang.String getButton()

getAscendingImage

public java.lang.String getAscendingImage()

getDescendingImage

public java.lang.String getDescendingImage()

getAscending2Image

public java.lang.String getAscending2Image()

getDescending2Image

public java.lang.String getDescending2Image()

getSection

public java.lang.String getSection()

getSectionTab

public java.lang.String getSectionTab()

Since:

4.2

getSectionTableAttributes

public java.lang.String getSectionTableAttributes()

getActiveSection

public java.lang.String getActiveSection()

Since:

4.2, renamed from getSectionActive()

getSectionLink

public java.lang.String getSectionLink()

getSectionLinkStyle

public java.lang.String getSectionLinkStyle()

getSectionBarStartDecoration

public java.lang.String getSectionBarStartDecoration()

getSectionBarEndDecoration

public java.lang.String getSectionBarEndDecoration()

getActiveSectionTabStartDecoration

public java.lang.String getActiveSectionTabStartDecoration(boolean first,
                                                           boolean last)

getSectionTabStartDecoration

public java.lang.String getSectionTabStartDecoration(boolean first,
                                                     boolean last)

getSectionTabStartDecoration

protected java.lang.String getSectionTabStartDecoration(boolean first,
                                                        boolean last,
                                                        boolean active)

getActiveSectionTabEndDecoration

public java.lang.String getActiveSectionTabEndDecoration()

getSectionTabEndDecoration

public java.lang.String getSectionTabEndDecoration()

getCollectionListActions

public java.lang.String getCollectionListActions()

getRestoreImage

public java.lang.String getRestoreImage()

If it starts with '/' the URI is absolute, otherwise the context path is inserted before.

getMaximizeImage

public java.lang.String getMaximizeImage()

If it starts with '/' the URI is absolute, otherwise the context path is inserted before.

getMinimizeImage

public java.lang.String getMinimizeImage()

If it starts with '/' the URI is absolute, otherwise the context path is inserted before.

getRemoveImage

public java.lang.String getRemoveImage()

If it starts with '/' the URI is absolute, otherwise the context path is inserted before.

getLoadingImage

public java.lang.String getLoadingImage()

isAlignHeaderAsData

public boolean isAlignHeaderAsData()

If true By default is false and it's used the portal default alignament for headers.

isFixedPositionSupported

public boolean isFixedPositionSupported()

isApplySelectedStyleToCellInList

public boolean isApplySelectedStyleToCellInList()

If true the style for selected row (or special style) in a list is applied to the row (tr) and to also the cell (td).

If false the style is applied only to the row (tr).

By default is true.

isShowImageInButtonBarButton

public boolean isShowImageInButtonBarButton()

isShowModuleDescription

public boolean isShowModuleDescription()

Since:

4.2

isShowPageNumber

public boolean isShowPageNumber()

Since:

4.2

isRowLinkable

public boolean isRowLinkable()

Since:

4.2

getBottomButtonsStyle

public java.lang.String getBottomButtonsStyle()

getBottomButtons

public java.lang.String getBottomButtons()

isNeededToIncludeCalendar

public boolean isNeededToIncludeCalendar()

isChangingPageRowCountAllowed

public boolean isChangingPageRowCountAllowed()

Since:

4.2

isHideRowsAllowed

public boolean isHideRowsAllowed()

Since:

4.2

isShowRowCountOnTop

public boolean isShowRowCountOnTop()

Since:

4.2

isInsidePortal

public boolean isInsidePortal()

setInsidePortal

public void setInsidePortal(boolean insidePortal)

getSelectedRow

public java.lang.String getSelectedRow()

getSelectedRowStyle

public java.lang.String getSelectedRowStyle()

setBrowser

public void setBrowser(java.lang.String browser)

getBrowser

public java.lang.String getBrowser()

isFirefox

protected boolean isFirefox()

isIE6

protected boolean isIE6()

Since:

4m5

isIE7

protected boolean isIE7()

Since:

4m5

getCurrentRow

public java.lang.String getCurrentRow()

Since:

4m5

getCurrentRowCell

public java.lang.String getCurrentRowCell()

Since:

4m5

getPageNavigationSelected

public java.lang.String getPageNavigationSelected()

Since:

4m5

getPageNavigation

public java.lang.String getPageNavigation()

Since:

4m5

getPageNavigationPages

public java.lang.String getPageNavigationPages()

Since:

4.2

getPageNavigationArrow

public java.lang.String getPageNavigationArrow()

Since:

4m5

getNextPageNavigationEvents

public java.lang.String getNextPageNavigationEvents(java.lang.String listId)

Since:

4.2

getPreviousPageNavigationEvents

public java.lang.String getPreviousPageNavigationEvents(java.lang.String listId)

Since:

4.2

getPageNavigationArrowDisable

public java.lang.String getPageNavigationArrowDisable()

Since:

4m5

getRowsPerPage

public java.lang.String getRowsPerPage()

Since:

4m5

isHelpAvailable

public boolean isHelpAvailable()

Since:

4.2

getHelpImage

public java.lang.String getHelpImage()

Since:

4m6

getHelp

public java.lang.String getHelp()

CSS class for the help icon, link or button.

Since:

4m6

getTotalRow

public java.lang.String getTotalRow()

getTotalCell

public java.lang.String getTotalCell()

getTotalCapableCell

public java.lang.String getTotalCapableCell()

getTotalCellStyle

public java.lang.String getTotalCellStyle()

getTotalEmptyCellStyle

public java.lang.String getTotalEmptyCellStyle()

getTotalLabelCellStyle

public java.lang.String getTotalLabelCellStyle()

Since:

4.3

getTotalCapableCellStyle

public java.lang.String getTotalCapableCellStyle()

getFilterCell

public java.lang.String getFilterCell()

Since:

4.2