ComponentPreferencesPlugin - JBOSS Portal 2.2 API 英文版文档

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.jboss.portal.server.plugins.preferences
Class ComponentPreferencesPlugin

java.lang.Object
  org.jboss.portal.common.value.SimpleValueMap
      org.jboss.portal.server.plugins.preferences.ComponentPreferencesPlugin

All Implemented Interfaces:: AdapterPlugin, ComponentPreferences, Plugin, Preferences, ValueMap

Direct Known Subclasses:: PortletPreferencesPlugin

public class ComponentPreferencesPlugin
extends SimpleValueMap
implements ComponentPreferences, AdapterPlugin

Field Summary

protected PluginContainer container


protected LocalizedString descs


protected org.apache.log4j.Logger log


protected PreferencesMetaData metadata


protected java.util.Map readOnlyMap


Fields inherited from class org.jboss.portal.common.value.SimpleValueMap

values

Constructor Summary

ComponentPreferencesPlugin()


Method Summary

void destroy()


java.lang.Class getAdaptedClass()
          Return the classname adapted by the adapter.

java.lang.Object getAdapter()
          Return the adapter instance.

LocalizedString getDescription(java.lang.String key)
          Return the description for the specified key or null if it does not exist.

void init(PluginContext pluginContext)


boolean isReadOnly(java.lang.String key)
          Return the read only value for the given preference.

void setReadOnly(java.lang.String key, boolean readOnly)
          Update the read only value for the given key.

void setValue(java.lang.String key, Value value)
          Update the value of the given key.

Methods inherited from class org.jboss.portal.common.value.SimpleValueMap

getKeys, getValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jboss.portal.common.value.ValueMap

getKeys, getValue

Field Detail

log

protected org.apache.log4j.Logger log

metadata

protected PreferencesMetaData metadata

container

protected PluginContainer container

descs

protected LocalizedString descs

readOnlyMap

protected java.util.Map readOnlyMap

Constructor Detail

ComponentPreferencesPlugin

public ComponentPreferencesPlugin()

Method Detail

getAdaptedClass

public java.lang.Class getAdaptedClass()

Description copied from interface: AdapterPlugin

Return the classname adapted by the adapter.

Specified by:: getAdaptedClass in interface AdapterPlugin

getAdapter

public java.lang.Object getAdapter()

Description copied from interface: AdapterPlugin

Return the adapter instance.

Specified by:: getAdapter in interface AdapterPlugin

init

public void init(PluginContext pluginContext)

Specified by:: init in interface Plugin

Parameters:: pluginContext -

getDescription

public LocalizedString getDescription(java.lang.String key)

Description copied from interface: ComponentPreferences

Return the description for the specified key or null if it does not exist.

Specified by:: getDescription in interface ComponentPreferences

Parameters:: key -
Returns:

destroy

public void destroy()

Specified by:: destroy in interface Plugin

isReadOnly

public boolean isReadOnly(java.lang.String key)
                   throws java.lang.IllegalArgumentException

Description copied from interface: Preferences

Return the read only value for the given preference.

Specified by:: isReadOnly in interface Preferences

Parameters:: key - the requested key
Returns:: the read only value
Throws:: java.lang.IllegalArgumentException - if the key is null

setReadOnly

public void setReadOnly(java.lang.String key,
                        boolean readOnly)
                 throws java.lang.IllegalArgumentException,
                        java.lang.UnsupportedOperationException