|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.opengts.db.BasicPrivateLabel
org.opengts.war.tools.PrivateLabel
public class PrivateLabel
| Nested Class Summary | |
|---|---|
static class |
PrivateLabel.JSPEntry
|
| Field Summary | |
|---|---|
static java.lang.String |
CONTEXT_FILE_OFFLINE
|
static java.lang.String |
DEFAULT_CSS_DIR
|
static java.lang.String |
JSPENTRY_DEFAULT
|
| Constructor Summary | |
|---|---|
protected |
PrivateLabel(java.lang.String host)
Constructor |
| Method Summary | ||
|---|---|---|
protected java.lang.String |
_getWebPageJSP(RequestProperties reqState)
Gets the default WebPage JSP URI (adjusted by RequestProperties) |
|
void |
addMapProvider(MapProvider mapProv)
Adds a supported MapProvider. |
|
void |
clearTimeZones()
Clears TimeZone cache |
|
static java.lang.String |
GetContextOfflineMessage()
Gets the Context offline message. |
|
java.lang.String |
getCssDirectory()
Gets the CSS directory |
|
PageDecorations |
getDefaultPageDecorations()
Gets the default page decorations |
|
|
getEnumComboMap(java.lang.Class<T> enumClass)
Gets a ComboMap of the enumnerated values specified by the Enum class |
|
|
getEnumComboMap(java.lang.Class<T> enumClass,
T[] list)
Gets a ComboMap of the enumnerated values specified by the Enum class |
|
ComboOption |
getEnumComboOption(EnumTools.StringLocale enumType)
Gets a ComboOption encapsulating the specified Enum type |
|
static java.lang.String |
GetGlobalOfflineMessage()
Gets the Global offline message. |
|
static OrderedMap<java.lang.String,PushpinIcon> |
GetGlobalPushpinIcons()
|
|
PrivateLabel.JSPEntry |
getJSPEntry(java.lang.String jspName)
Gets the named JSPEntry. |
|
OrderedMap<java.lang.String,java.lang.String> |
getJSPEntryDescriptions(java.util.Locale locale)
Gets a map of JSPEntry names/descriptions |
|
java.util.Set<java.lang.String> |
getJSPEntryNames()
Gets a set of JSPEntry names |
|
java.lang.String |
getJSPFile(java.lang.String jspName,
boolean rtnDefault)
Gets the named JSPEntry |
|
MapProvider |
getMapProvider()
Returns the first MapProvider |
|
MapProvider |
getMapProvider(java.lang.String name)
Gets the named MapProvider |
|
int |
getMapProviderCount()
Returns the number of MapProviders |
|
java.util.Map<java.lang.String,MapShape> |
getMapShapes()
Gets the global MapShapes |
|
java.util.Map<java.lang.String,MenuGroup> |
getMenuGroupMap()
Gets the MenuGroup map |
|
static java.lang.String |
GetOfflineMessage()
Gets the Context/Global offline message. |
|
java.util.List<PoiProvider> |
getPointsOfInterest()
Gets the global PointsOfInterest |
|
int |
getPushpinIconIndex(java.lang.String mapProviderID,
java.lang.String pushpinID,
int dftIndex)
Return the MapProvider's Pushpin index for the specified pushpin ID |
|
ReportEntry |
getReportEntry(java.lang.String rptName)
Gets the named ReportFactory |
|
ReportFactory |
getReportFactory(java.lang.String rptName)
Gets the named ReportFactory |
|
java.util.Map<java.lang.String,ReportEntry> |
getReportMap()
Gets the ReportEntry map |
|
ComboMap |
getTimeZoneComboMap()
Gets a ComboMap of supported TimeZones |
|
PageDecorations |
getUserPageDecorations()
Gets the user page decorations |
|
WebPage |
getWebPage(java.lang.String pageName)
Gets the named WebPage |
|
java.lang.String |
getWebPageJSP()
Gets the assigned WebPage JSP URI |
|
java.lang.String |
getWebPageJSP(java.lang.String jsp,
RequestProperties reqState)
Gets the WebPage JSP URI |
|
java.util.Map<java.lang.String,WebPage> |
getWebPageMap()
Gets the WebPage map |
|
java.lang.String |
getWebPageURL(RequestProperties reqState,
java.lang.String pageName)
Gets the URL to the named WebPage |
|
java.lang.String |
getWebPageURL(RequestProperties reqState,
java.lang.String pageName,
java.lang.String command)
Gets the URL to the named WebPage |
|
java.lang.String |
getWebPageURL(RequestProperties reqState,
java.lang.String pageName,
java.lang.String command,
java.lang.String arg)
Gets the URL to the named WebPage |
|
boolean |
hasReport(java.lang.String rptName)
Returns true if the named ReportFactory has been defined |
|
boolean |
hasUserPageDecorations()
Returns true if user page decorations have been defined |
|
boolean |
hasWebPage(java.lang.String pageName)
Returns true if the named WebPage is defined |
|
java.lang.String |
resolveCssFile(java.lang.String cssFileName,
java.lang.String cssFileDir)
Resolves the path to the specified CSS dir/file |
|
static void |
SetContextOfflineMessage(java.lang.String msg)
Sets the context offline message Note: This method effects only the Context offline settings. |
|
void |
setCssDirectory(java.lang.String cssDir)
Sets the CSS directory |
|
void |
setDefaultPageDecorations(PageDecorations pd)
Sets the default page decorations |
|
void |
setJSPMap(java.util.Map<java.lang.String,PrivateLabel.JSPEntry> jspMap)
Sets the JSPEntry map |
|
void |
setMapShapes(java.util.List<MapShape> shapeList)
Sets the global MapShapes |
|
void |
setMenuGroupMap(java.util.Map<java.lang.String,MenuGroup> menuGroupMap)
Sets the MenuGroup map |
|
void |
setPointsOfInterest(java.util.List<PoiProvider> poiList)
Sets the global PointsOfInterest |
|
void |
setReportMap(java.util.Map<java.lang.String,ReportEntry> reportMap)
Sets the ReportEntry map |
|
void |
setUserPageDecorations(PageDecorations pd)
Sets the user page decorations |
|
void |
setWebPageJSP(java.lang.String dftJSP)
Sets the default JSP URI |
|
void |
setWebPageMap(java.util.Map<java.lang.String,WebPage> pageMap)
Sets the WebPage map |
|
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
public static final java.lang.String DEFAULT_CSS_DIR
public static final java.lang.String JSPENTRY_DEFAULT
public static final java.lang.String CONTEXT_FILE_OFFLINE
| Constructor Detail |
|---|
protected PrivateLabel(java.lang.String host)
host - host/domain name| Method Detail |
|---|
public static OrderedMap<java.lang.String,PushpinIcon> GetGlobalPushpinIcons()
public boolean hasUserPageDecorations()
public void setUserPageDecorations(PageDecorations pd)
pd - The user page decorationspublic PageDecorations getUserPageDecorations()
public void setDefaultPageDecorations(PageDecorations pd)
pd - The default page decorationspublic PageDecorations getDefaultPageDecorations()
public void addMapProvider(MapProvider mapProv)
mapProv - The MapProviderpublic MapProvider getMapProvider()
public MapProvider getMapProvider(java.lang.String name)
name - The name of the MapProvider to returnpublic int getMapProviderCount()
public int getPushpinIconIndex(java.lang.String mapProviderID,
java.lang.String pushpinID,
int dftIndex)
getPushpinIconIndex in class BasicPrivateLabelmapProviderID - The MapProvider ID (may be null)pushpinID - The pushpin IDdftIndex - The default index value (0..9 are always defined)
public void setWebPageJSP(java.lang.String dftJSP)
dftJSP - The default JSP URI (may be a name, or absolute URI path entry)public java.lang.String getWebPageJSP()
protected java.lang.String _getWebPageJSP(RequestProperties reqState)
public java.lang.String getWebPageJSP(java.lang.String jsp,
RequestProperties reqState)
public void setCssDirectory(java.lang.String cssDir)
cssDir - The CSS directorypublic java.lang.String getCssDirectory()
public java.lang.String resolveCssFile(java.lang.String cssFileName,
java.lang.String cssFileDir)
cssFileName - The CSS file namecssFileDir - An optional CSS file directory
public static java.lang.String GetContextOfflineMessage()
public static java.lang.String GetGlobalOfflineMessage()
public static java.lang.String GetOfflineMessage()
public static void SetContextOfflineMessage(java.lang.String msg)
msg - The offline message, or 'null' to place back 'online'public void setWebPageMap(java.util.Map<java.lang.String,WebPage> pageMap)
pageMap - The WebPage mappublic java.util.Map<java.lang.String,WebPage> getWebPageMap()
public WebPage getWebPage(java.lang.String pageName)
pageName - The name of the WebPage to return
public boolean hasWebPage(java.lang.String pageName)
pageName - The name of the WebPage to test
public java.lang.String getWebPageURL(RequestProperties reqState,
java.lang.String pageName)
pageName - The name of the WebPagereqState - The RequestProperties
public java.lang.String getWebPageURL(RequestProperties reqState,
java.lang.String pageName,
java.lang.String command)
pageName - The name of the WebPagereqState - The RequestPropertiescommand - The command to append to the URL
public java.lang.String getWebPageURL(RequestProperties reqState,
java.lang.String pageName,
java.lang.String command,
java.lang.String arg)
pageName - The name of the WebPagereqState - The RequestPropertiescommand - The command to append to the URLarg - The command argument to append to the URL
public void setMenuGroupMap(java.util.Map<java.lang.String,MenuGroup> menuGroupMap)
menuGroupMap - The MenuGroup mappublic java.util.Map<java.lang.String,MenuGroup> getMenuGroupMap()
public void setReportMap(java.util.Map<java.lang.String,ReportEntry> reportMap)
reportMap - The ReportEntry mappublic java.util.Map<java.lang.String,ReportEntry> getReportMap()
public ReportEntry getReportEntry(java.lang.String rptName)
rptName - The ReportFactory name to return
public ReportFactory getReportFactory(java.lang.String rptName)
rptName - The ReportFactory name to return
public boolean hasReport(java.lang.String rptName)
rptName - The ReportFactory name to test
public void setJSPMap(java.util.Map<java.lang.String,PrivateLabel.JSPEntry> jspMap)
jspMap - The JSPEntry mappublic java.util.Set<java.lang.String> getJSPEntryNames()
public OrderedMap<java.lang.String,java.lang.String> getJSPEntryDescriptions(java.util.Locale locale)
public PrivateLabel.JSPEntry getJSPEntry(java.lang.String jspName)
jspName - The JSPEntry name to return
public java.lang.String getJSPFile(java.lang.String jspName,
boolean rtnDefault)
jspName - The JSPEntry name to returnrtnDefault - True to return "default" JSP if jsp name is not found
public void setPointsOfInterest(java.util.List<PoiProvider> poiList)
poiList - The PointsOfInterest listpublic java.util.List<PoiProvider> getPointsOfInterest()
getPointsOfInterest in class BasicPrivateLabelpublic void setMapShapes(java.util.List<MapShape> shapeList)
shapeList - The MapShape listpublic java.util.Map<java.lang.String,MapShape> getMapShapes()
public void clearTimeZones()
clearTimeZones in class BasicPrivateLabelpublic ComboMap getTimeZoneComboMap()
public <T extends java.lang.Enum<T>> ComboMap getEnumComboMap(java.lang.Class<T> enumClass)
public <T extends java.lang.Enum<T>> ComboMap getEnumComboMap(java.lang.Class<T> enumClass,
T[] list)
public ComboOption getEnumComboOption(EnumTools.StringLocale enumType)
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||