com.plumtree.portaluiinfrastructure.application.varpacks
Class PTNavSettingsVarPack

java.lang.Object
  com.plumtree.uiinfrastructure.web.BaseVarPack
      com.plumtree.portaluiinfrastructure.application.varpacks.PTNavSettingsVarPack

All Implemented Interfaces:

IVarPack

public class PTNavSettingsVarPack
extends BaseVarPack

Varpack to load navigation sepcific settings.

Author:

Robert Zhang

Field Summary

static java.lang.String	INTHORIZONTALNAVTAB_TRUNCATION_WIDTH
static java.lang.String	INTHORIZONTALNAVTAB_WIDTH
static java.lang.String	INTISCDROPDOWNMENU_TRUNCATION_WIDTH Constants for settings defined in the file
static java.lang.String	INTISCDROPDOWNMENU_WIDTH
static java.lang.String	INTMYPORTLETPREFBUTTON_IN_PORTLETHEADER
static java.lang.String	INTPLUMTREEDPLEFTWIDTH
static java.lang.String	INTPLUMTREEDPLEFTWIDTHALONE
static java.lang.String	INTPLUMTREEDPRIGHTWIDTH
static java.lang.String	INTPLUMTREEDPRIGHTWIDTHALONE
static java.lang.String	INTPLUMTREEDPTABLESPACING
static java.lang.String	PORTAL_NAVIGATION_COMPONENT_TYPE
static java.lang.String	VARPACK_ID The string ID of this variable package.

Constructor Summary

PTNavSettingsVarPack()

Method Summary

protected void	ExpireContent() Not implemented.
protected java.lang.Object	GetValue(java.lang.String strNavSetting) Get the value of the specified navigation settings.
java.lang.String	GetVarPackID() Get the varpack ID.
IXPEnumerator	GetVarPackKeys() Returns the enumeration of the navigation setting keys.
protected void	Load() This method loads the NavigationSettings.xml file into memory.
protected void	Reload() Clears and reloads all settings from the xml fie.

Methods inherited from class com.plumtree.uiinfrastructure.web.BaseVarPack

CanReloadVarPackFromUI, ExpireVarPackContent, GetConfigPath, GetExpireTimeout, GetLastAccessedTimeStamp, GetReloadInterval, GetVarPackValue, IsLoaded, LoadVarPack, ReloadVarPack, SetExpireTimeout, SetReloadInterval

Methods inherited from class java.lang.Object

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

Field Detail

VARPACK_ID

public static final java.lang.String VARPACK_ID

The string ID of this variable package.

See Also:

Constant Field Values

INTISCDROPDOWNMENU_TRUNCATION_WIDTH

public static final java.lang.String INTISCDROPDOWNMENU_TRUNCATION_WIDTH

Constants for settings defined in the file

See Also:

Constant Field Values

INTISCDROPDOWNMENU_WIDTH

public static final java.lang.String INTISCDROPDOWNMENU_WIDTH

See Also:

Constant Field Values

INTHORIZONTALNAVTAB_TRUNCATION_WIDTH

public static final java.lang.String INTHORIZONTALNAVTAB_TRUNCATION_WIDTH

See Also:

Constant Field Values

INTHORIZONTALNAVTAB_WIDTH

public static final java.lang.String INTHORIZONTALNAVTAB_WIDTH

See Also:

Constant Field Values

INTMYPORTLETPREFBUTTON_IN_PORTLETHEADER

public static final java.lang.String INTMYPORTLETPREFBUTTON_IN_PORTLETHEADER

See Also:

Constant Field Values

INTPLUMTREEDPTABLESPACING

public static final java.lang.String INTPLUMTREEDPTABLESPACING

See Also:

Constant Field Values

INTPLUMTREEDPLEFTWIDTH

public static final java.lang.String INTPLUMTREEDPLEFTWIDTH

See Also:

Constant Field Values

INTPLUMTREEDPRIGHTWIDTH

public static final java.lang.String INTPLUMTREEDPRIGHTWIDTH

See Also:

Constant Field Values

INTPLUMTREEDPLEFTWIDTHALONE

public static final java.lang.String INTPLUMTREEDPLEFTWIDTHALONE

See Also:

Constant Field Values

INTPLUMTREEDPRIGHTWIDTHALONE

public static final java.lang.String INTPLUMTREEDPRIGHTWIDTHALONE

See Also:

Constant Field Values

PORTAL_NAVIGATION_COMPONENT_TYPE

public static final java.lang.String PORTAL_NAVIGATION_COMPONENT_TYPE

See Also:

Constant Field Values

Constructor Detail

PTNavSettingsVarPack

public PTNavSettingsVarPack()

Method Detail

GetVarPackID

public java.lang.String GetVarPackID()

Get the varpack ID.

Specified by:

GetVarPackID in interface IVarPack

Specified by:

GetVarPackID in class BaseVarPack

Returns:

A unique key to store the var pack in the varpackmanager.

See Also:

IVarPack.GetVarPackID()

GetVarPackKeys

public IXPEnumerator GetVarPackKeys()

Returns the enumeration of the navigation setting keys. null if nothing was loaded.

Specified by:

GetVarPackKeys in interface IVarPack

Specified by:

GetVarPackKeys in class BaseVarPack

Returns:

IXPEnumerator of keys in the var pack.

See Also:

IVarPack.GetVarPackKeys()

ExpireContent

protected void ExpireContent()

Not implemented.

Specified by:

ExpireContent in class BaseVarPack

See Also:

com.plumtree.xpsupport.web.BaseVarPack#ExpireContent()

GetValue

protected java.lang.Object GetValue(java.lang.String strNavSetting)

Get the value of the specified navigation settings. null if settings doesn't exist.

Specified by:

GetValue in class BaseVarPack

Parameters:

strNavSetting - The key for the lookup

Returns:

the value from the lookup (null if not found)

See Also:

com.plumtree.xpsupport.web.BaseVarPack#GetValue(String)

Load

protected void Load()

This method loads the NavigationSettings.xml file into memory.

Specified by:

Load in class BaseVarPack

See Also:

com.plumtree.xpsupport.web.BaseVarPack#Load()

Reload

protected void Reload()

Clears and reloads all settings from the xml fie.

Specified by:

Reload in class BaseVarPack

See Also:

com.plumtree.xpsupport.web.BaseVarPack#Reload()