Package com.webmethods.portal.mech.themes

Interface ISkinMechanics

All Superinterfaces:

IAccessMechanics, IBasicMechanics, IClipboardMechanics, IComponent, IInitializable, IMechanics, ISubscribableMechanics, ISystemHandler, IViewableMechanics

public interface ISkinMechanics
extends IBasicMechanics

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CLIENT_SIDE_RESOURCE_PATH
static final String	PARENT
static final String	RESET_SKIN_COMMAND_NAME
static final String	SERVER_SIDE_RESOURCE_PATH
static final String	SKIN_ID_ATTR

Fields inherited from interface com.webmethods.portal.mech.access.IAccessMechanics

ACCESS_DENIED, ACCESS_GRANTED, ACCESS_RIGHT_ID, ACCESS_RIGHT_LONG_NAME, ACCESS_RIGHT_SHORT_NAME, ACCESS_RIGHTS_CONTAINER, ACCESS_UNSPECIFIED, AUTH_LEVEL_ANONYMOUS, AUTH_LEVEL_BASIC, AUTH_LEVEL_DEFAULT, AUTH_LEVEL_FULL_ACCESS, AUTH_LEVEL_KERBEROS, AUTH_LEVEL_NTLM, AUTH_LEVEL_PROPERTY

Fields inherited from interface com.webmethods.portal.mech.storage.IBasicMechanics

PROP_CUSTOM_FILE_ENCODING, PROP_FILE_ENCODING, TITLEBAR_ACTION_SHOW_ADD_TO_HOME, TITLEBAR_ACTION_SHOW_DISPLAY_OPTIONS, TITLEBAR_ACTION_SHOW_MAXIMIZED, TITLEBAR_ACTION_SHOW_MINIMIZED, TITLEBAR_ACTION_SHOW_NORMAL

Fields inherited from interface com.webmethods.portal.mech.subscription.ISubscribableMechanics

CONTENT_FORMAT_EMAIL, CONTENT_FORMAT_EMAIL_DIGEST, CONTENT_FORMAT_PORTAL_INBOX, CONTENT_FORMAT_PORTAL_INBOX_DIGEST, HEADER_FROM, HEADER_SUBJECT, HEADER_TO

Fields inherited from interface com.webmethods.portal.mech.view.IViewableMechanics

COMMENTS_LINK_TYPE, CONTENT_LINK_TYPE, DEFAULT_ORDER, DEFAULT_PAGE_SIZE, DEFAULT_SORT, DETAILS_LINK_TYPE, LARGE_ICON_TYPE, LINK_TYPE, LINK_TYPE_COMMENTS, LINK_TYPE_CONTENT, LINK_TYPE_DETAILS, LINK_TYPE_EDIT, LINK_TYPE_HELP, LINK_TYPE_HELP_MAXIMIZED, LINK_TYPE_MAXIMIZED, LINK_TYPE_MINIMIZED, LINK_TYPE_PERMISSIONS, LINK_TYPE_PORTAL_CONTENT, LINK_TYPE_PORTLET_STANDALONE, LINK_TYPE_PROPERTIES, LINK_TYPE_RESTORED, LINK_TYPE_SUBSCRIPTIONS, LINK_TYPE_THUMBNAILS, LINK_TYPE_VERSIONS, PERMISSIONS_LINK_TYPE, PORTAL_CONTENT_LINK_TYPE, PROPERTIES_LINK_TYPE, PROPERTY_LINK_TARGET, PROPERTY_OWNER_NAME, PROPERTY_PARENT_NAME, PROPERTY_TOOLTIP, REFERENCE_ICON_TYPE, SUBSCRIPTIONS_LINK_TYPE, THUMBNAIL_ICON_TYPE, THUMBNAILS_LINK_TYPE, VERSIONS_LINK_TYPE

Method Summary

Modifier and Type	Method	Description
Map<String,String>	getClientProperties(IThingID skin)	Client-side properties for the specified skin.
String	getClientProperty(IThingID skin, String name)	Client-side property value (ie '/portal/ui/portlet/wm_skin_fancy/images/logo.gif') for the specified skin and property name (ie 'images/logo.gif').
String	getClientProperty(Map<String,String> properties, String name)	Client-side property value (ie '/ui/portlet/wm_skin_fancy/images/logo.gif') for the specified skin and property name (ie 'images/logo.gif').
String	getClientSideResourcePath(IThingID skinID)	Gets the path to the client side resources of the skin.
Map<String,String>	getCurrentClientProperties(IContext ctx)	Client-side properties for the current user's skin.
String	getCurrentClientProperty(IContext ctx, String name)	Client-side property value (ie '/ui/portlet/wm_skin_fancy/images/logo.gif') for the current user's skin and specified property name (ie 'images/logo.gif').
Map<String,String>	getCurrentRawProperties(IContext ctx)	Raw properties for the current user's skin.
String	getCurrentRawProperty(IContext ctx, String name)	Raw property value (ie '#003366') for the current user's skin and specified property name (ie 'colors/dark-bg').
Map<String,String>	getCurrentServerProperties(IContext ctx)	Server-side properties for the current user's skin.
String	getCurrentServerProperty(IContext ctx, String name)	Server-side property value (ie '/ui/portlet/wm_skin_fancy/components/tab.nbsp') for the current user's skin and specified property name (ie 'components/tab.nbsp').
IThingID	getCurrentSkinID(IContext ctx)	Current user's skin.
Map<String,String>	getRawProperties(IThingID skin)	Raw properties for the specified skin.
String	getRawProperty(IThingID skin, String name)	Raw property value (ie '#003366') for the specified skin and property name (ie 'colors/dark-bg').
String	getRawProperty(Map<String,String> properties, String name)	Raw property value (ie '#003366') for the specified skin and property name (ie 'colors/dark-bg').
Map<String,String>	getServerProperties(IThingID skin)	Server-side properties for the specified skin.
String	getServerProperty(IThingID skin, String name)	Server-side property value (ie '/ui/portlet/wm_skin_fancy/components/tab.nbsp') for the specified skin and property name (ie 'components/tab.nbsp').
String	getServerProperty(Map<String,String> properties, String name)	Server-side property value (ie '/ui/portlet/wm_skin_fancy/components/tab.nbsp') for the specified skin and property name (ie 'components/tab.nbsp').
String	getServerSideResourcePath(IThingID skinID)	Gets the path to the server side resources of the skin
IThingID	getSkinArchive(IThingID skinId)	Gets skin's .skin component archive.
IMechanics	getSkinComponentMechanics(IThingID skinID)	Gets the component mechanics for this skin.
void	loadSkin(IThingID skin)	Loads skin properties for the specified skin.
void	reloadSkin(IThingID skin)	Reloads skin properties for the specified skin.
void	reloadSkins()	Reloads skin properties for all (loaded) skins.
void	updateSkinArchive(IThingID skinId, IThingID archiveId, Map<String,String> properties)	Updates skin's .skin component archive.

Methods inherited from interface com.webmethods.portal.mech.access.IAccessMechanics

canRemoveSecurityRealm, canSetSecurityRealm, checkAccess, checkAccessEx, checkRemoveSecurityRealm, checkSetSecurityRealm, cloneAces, fireRemoveAcccesEvent, fireRemoveSecurityRealmEvent, fireSetAccessEvent, fireSetAuthenticationEvent, fireSetOwnerEvent, fireSetSecurityRealmEvent, getAccessEx, getAccessList, getAccessListEx, getAclView, getAuthLevelForAuthScheme, getAuthScheme, getAuthSchemeForAuthLevel, getAuthSchemeForResource, getAvailableAuthSchemes, getDefaultAuthScheme, getRightNameForValue, getRightsForType, getRightValueForName, getSecurityRealm, invalidateAcesForThing, invalidateAcesForUser, listSecurityRealmObjects, removeAces, removeSecurityRealm, setAces, setAcesEx, setSecurityRealm, setSecurityRealm

Methods inherited from interface com.webmethods.portal.mech.storage.IBasicMechanics

addNote, addReference, addRelation, canAddNote, canCloneRemote, canCreate, canDelete, canDestroy, canDoTitlebarAction, canListAccess, canListContainers, canListNotes, canRemoveAccess, canRemoveNote, canSetAccess, canSetAuthentication, canSetOwner, canUninstall, canUpdateContent, canUpdateProperties, canVerb, canViewAuthentication, canViewContent, checkAddNote, checkCloneRemote, checkCreate, checkDelete, checkDestroy, checkListAccess, checkListContainers, checkListNotes, checkRemoveAccess, checkRemoveNote, checkSetAccess, checkSetAuthentication, checkSetOwner, checkUninstall, checkUpdateContent, checkUpdateProperties, checkViewAuthentication, checkViewContent, cloneRemote, copy, create, create, delete, destroy, doAfterInstall, doAfterUpgrade, doBeforeUninstall, doBeforeUpgrade, fireAddNoteEvent, fireCacheInvalidateEvent, fireDeleteEvent, fireInsoEvent, fireListAccessEvent, fireListContainersEvent, fireListNotesEvent, firePurgeEvent, fireRemoveAcccesEvent, fireRemoveNoteEvent, fireSetAccessEvent, fireSetAuthenticationEvent, fireSetOwnerEvent, fireUpdateContentEvent, fireUpdatePropertiesEvent, fireViewAuthenticationEvent, fireViewContentEvent, getAccess, getAncestors, getAuthentication, getContent, getContent, getContentStore, getContentStore, getDependencyList, getPrimaryRelatedChild, getPrimaryRelatedContainer, getTimeToLive, isAnonymous, isBaseType, isContainer, isNormal, isReference, isVersionable, isWorkflowEnabled, listAccess, listAccess, listContainers, listContainers, listDependants, listNotes, listRelatedChildren, listRelatedContainers, move, move, prepareForDeletion, removeNote, removeReference, removeRelation, restoreXTypeConfProps, saveXTypeConfProps, setAuthentication, setOwner, setTimeToLive, undeleteAllUndestroyed, updateContent, updateContent, updateProperties, updateProperties

Methods inherited from interface com.webmethods.portal.mech.clipboard.IClipboardMechanics

canCopyToClipboard, canCutToClipboard, checkCopyToClipboard, checkCutToClipboard, copyToClipboard, cutToClipboard, getClipboard, getClipboardInfo, newClipboardItem

Methods inherited from interface com.webmethods.portal.system.IComponent

getComponentData, getComponentName, getComponentProvider, getURI, isInitialized, setComponentData, setComponentProvider

Methods inherited from interface com.webmethods.portal.system.init.IInitializable

init, shutdown

Methods inherited from interface com.webmethods.portal.mech.subscription.ISubscribableMechanics

canDeliverToPrincipal, canEditSubscription, canListSubscriptions, canViewSubscription, checkEditSubscription, checkListSubscriptions, checkViewSubscription, checkViewSubscription, createAppCriteria, createAppCriteriaFolder, createPortletSubscription, createPortletSubscription, disable, disable, disableBySystem, disableBySystem, enable, enable, fireGetAppCriteriaEvent, fireGetSubscriptionEvent, fireSetSubscriptionEvent, fireUnsubscribeEvent, fireViewSubscriptionEvent, generateNotificationContent, generateNotificationHeaders, getAppCriteria, getGroupSubscription, getSubscription, listSubscriptions, listSubscriptions, setGroupSubscription, setGroupSubscription, setSubscription, setSubscription, unsubscribe, unsubscribe, viewSubscription

Methods inherited from interface com.webmethods.portal.mech.view.IViewableMechanics

canView, checkView, createPagingCookie, fireViewEvent, getCss, getCss, getDefaultLinkType, getFormattedProperty, getHierachicalUri, getIcon, getIcon, getLink, getLink, getListProperty, getListPropertyHTML, getListPropertyJS, isEnabled, view, view

Field Details

PARENT

static final String PARENT

See Also:

• Constant Field Values

SERVER_SIDE_RESOURCE_PATH

static final String SERVER_SIDE_RESOURCE_PATH

See Also:

• Constant Field Values

CLIENT_SIDE_RESOURCE_PATH

static final String CLIENT_SIDE_RESOURCE_PATH

See Also:

• Constant Field Values

SKIN_ID_ATTR

static final String SKIN_ID_ATTR

RESET_SKIN_COMMAND_NAME

static final String RESET_SKIN_COMMAND_NAME

See Also:

• Constant Field Values

Method Details

getServerSideResourcePath

String getServerSideResourcePath(IThingID skinID)
                          throws PortalException

Gets the path to the server side resources of the skin

Parameters:

skinID -

Returns:

Throws:

PortalException

getClientSideResourcePath

String getClientSideResourcePath(IThingID skinID)
                          throws PortalException

Gets the path to the client side resources of the skin.

Parameters:

skinID -

Returns:

Throws:

PortalException

getSkinComponentMechanics

IMechanics getSkinComponentMechanics(IThingID skinID)
                              throws PortalException

Gets the component mechanics for this skin.

Throws:

PortalException

loadSkin

void loadSkin(IThingID skin)
       throws PortalException

Loads skin properties for the specified skin.

Throws:

PortalException

reloadSkin

void reloadSkin(IThingID skin)
         throws PortalException

Reloads skin properties for the specified skin.

Throws:

PortalException

reloadSkins

void reloadSkins()
          throws PortalException

Reloads skin properties for all (loaded) skins.

Throws:

PortalException

getRawProperties

Map<String,String> getRawProperties(IThingID skin)
                             throws PortalException

Raw properties for the specified skin.

Throws:

PortalException

getServerProperties

Map<String,String> getServerProperties(IThingID skin)
                                throws PortalException

Server-side properties for the specified skin.

Throws:

PortalException

getClientProperties

Map<String,String> getClientProperties(IThingID skin)
                                throws PortalException

Client-side properties for the specified skin.

Throws:

PortalException

getRawProperty

String getRawProperty(IThingID skin,
 String name)
               throws PortalException

Raw property value (ie '#003366') for the specified skin and property name (ie 'colors/dark-bg').

Throws:

PortalException

getServerProperty

String getServerProperty(IThingID skin,
 String name)
                  throws PortalException

Server-side property value (ie '/ui/portlet/wm_skin_fancy/components/tab.nbsp') for the specified skin and property name (ie 'components/tab.nbsp').

Throws:

PortalException

getClientProperty

String getClientProperty(IThingID skin,
 String name)
                  throws PortalException

Client-side property value (ie '/portal/ui/portlet/wm_skin_fancy/images/logo.gif') for the specified skin and property name (ie 'images/logo.gif').

Throws:

PortalException

getRawProperty

String getRawProperty(Map<String,String> properties,
 String name)
               throws PortalException

Raw property value (ie '#003366') for the specified skin and property name (ie 'colors/dark-bg').

Throws:

PortalException

getServerProperty

String getServerProperty(Map<String,String> properties,
 String name)
                  throws PortalException

Server-side property value (ie '/ui/portlet/wm_skin_fancy/components/tab.nbsp') for the specified skin and property name (ie 'components/tab.nbsp').

Throws:

PortalException

getClientProperty

String getClientProperty(Map<String,String> properties,
 String name)
                  throws PortalException

Client-side property value (ie '/ui/portlet/wm_skin_fancy/images/logo.gif') for the specified skin and property name (ie 'images/logo.gif').

Throws:

PortalException

getCurrentSkinID

IThingID getCurrentSkinID(IContext ctx)
                   throws PortalException

Current user's skin.

Throws:

PortalException

getCurrentRawProperties

Map<String,String> getCurrentRawProperties(IContext ctx)
                                    throws PortalException

Raw properties for the current user's skin.

Throws:

PortalException

getCurrentServerProperties

Map<String,String> getCurrentServerProperties(IContext ctx)
                                       throws PortalException

Server-side properties for the current user's skin.

Throws:

PortalException

getCurrentClientProperties

Map<String,String> getCurrentClientProperties(IContext ctx)
                                       throws PortalException

Client-side properties for the current user's skin.

Throws:

PortalException

getCurrentRawProperty

String getCurrentRawProperty(IContext ctx,
 String name)
                      throws PortalException

Raw property value (ie '#003366') for the current user's skin and specified property name (ie 'colors/dark-bg').

Throws:

PortalException

getCurrentServerProperty

String getCurrentServerProperty(IContext ctx,
 String name)
                         throws PortalException

Server-side property value (ie '/ui/portlet/wm_skin_fancy/components/tab.nbsp') for the current user's skin and specified property name (ie 'components/tab.nbsp').

Throws:

PortalException

getCurrentClientProperty

String getCurrentClientProperty(IContext ctx,
 String name)
                         throws PortalException

Client-side property value (ie '/ui/portlet/wm_skin_fancy/images/logo.gif') for the current user's skin and specified property name (ie 'images/logo.gif').

Throws:

PortalException

getSkinArchive

IThingID getSkinArchive(IThingID skinId)
                 throws PortalException

Gets skin's .skin component archive.

Throws:

PortalException

updateSkinArchive

void updateSkinArchive(IThingID skinId,
 IThingID archiveId,
 Map<String,String> properties)
                throws PortalException

Updates skin's .skin component archive.

Throws:

PortalException