atg.svc.ui.formhandlers
Class TopicChooserFormHandler

java.lang.Object
  atg.nucleus.GenericService
      atg.droplet.EmptyFormHandler
          atg.droplet.GenericFormHandler
              atg.droplet.TransactionalFormHandler
                  atg.web.formhandlers.ApplicationFormHandler
                      atg.svc.ui.formhandlers.test.TreeTableDelegatingFormHandler
                          atg.svc.ui.formhandlers.ListChooserFormHandler
                              atg.svc.ui.formhandlers.OrgChooserFormHandler
                                  atg.svc.ui.formhandlers.TopicChooserFormHandler

All Implemented Interfaces:

atg.droplet.DropletFormHandler, atg.naming.NameContextBindingListener, atg.naming.NameContextElement, atg.naming.NameResolver, atg.nucleus.AdminableService, atg.nucleus.logging.ApplicationLogging, atg.nucleus.naming.ComponentNameResolver, atg.nucleus.Service, atg.nucleus.ServiceListener, TreeTableFormHandler, Expandable, Listable, Selectable, java.util.EventListener

public class TopicChooserFormHandler
extends OrgChooserFormHandler

Topic Chooser TreeTable component as data retrieval, tree expansion, selection by delegating.

Version:

$Id: //application/service/version/2007.3/common-ui/src/classes/atg/svc/ui/formhandlers/TopicChooserFormHandler.java#2 $$Change: 632007 $

Author:

vkovalch

Field Summary

static java.lang.String	CLASS_VERSION Class version string
protected TopicService	mTopicService

Fields inherited from class atg.svc.ui.formhandlers.OrgChooserFormHandler

mBaseExpValue, mExpanded, mProfileRepository, ORG_ROOT, ORGANIZATION_VIEW

Fields inherited from class atg.svc.ui.formhandlers.ListChooserFormHandler

editorField, mAdminField, mBaseValue, mFilterKeyword, mItemKey, mRepository, mRepositoryView, mSegmentService, mSelectedKeys, mSolutionService, mViewItems, STATUS_FILTER_RQL, STATUS_VIEW

Fields inherited from class atg.svc.ui.formhandlers.test.TreeTableDelegatingFormHandler

mOperation, mParameters, mState, mTreeTableId, mView

Fields inherited from class atg.web.formhandlers.ApplicationFormHandler

EQUALS, PARAM_DELIMITER, QUERY_DELIMITER, STATUS_ERROR_REDIRECT, STATUS_ERROR_STAY, STATUS_SUCCESS

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

Fields inherited from interface atg.svc.ui.treetable.Selectable

SELECT_MULTIPLE, SELECT_NONE, SELECT_SINGLE

Fields inherited from interface atg.nucleus.logging.ApplicationLogging

DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS

Constructor Summary

TopicChooserFormHandler()

Method Summary

java.util.List	getChildren(java.lang.String pItemKey)
int	getItemDepth(java.lang.Object pItem) Implementation of Expandable interface.
boolean	getItemHasChildren(java.lang.Object pItem) Implementation of Expandable interface.
java.lang.String	getItemName()
java.util.List	getSelectedKeysList() Made to preserve sorting of mViewItems
java.util.List	getSubOrganizations(java.lang.String pItemKey)
TopicService	getTopicService()
java.util.List	getViewItems() Create collection of visible organization items.
protected java.util.List	prepareSelectedList(java.util.Collection repositoryItems, java.lang.String propertyName)
void	setTopicService(TopicService pTopicService)

Methods inherited from class atg.svc.ui.formhandlers.OrgChooserFormHandler

expand, getBaseExpValue, getExpandedKeysList, getProfileRepository, getTotalItemCount, getViewItemCount, resetListValue, setBaseExpValue, setProfileRepository, setState, sortBranch

Methods inherited from class atg.svc.ui.formhandlers.ListChooserFormHandler

fillSelectedFromState, filterListValues, findStateContainer, getAdminField, getAllRQLWhere, getBaseValue, getEditorConstraintType, getEditorField, getFilterKeyword, getFilterRQLWhere, getItemKey, getLanguageProperty, getLanguages, getRepository, getRepositoryView, getSegmentService, getSelectedItemsList, getSelectedKeys, getServiceFactory, getSolutionService, handleList, isStatusField, saveStateContainer, select, setAdminField, setBaseValue, setEditorConstraintType, setEditorField, setFilterKeyword, setItemKey, setLanguageProperty, setRepository, setRepositoryView, setSegmentService, setServiceFactory, setSolutionService, setViewItems, uploadRepositoryItems, uploadViewItems, wrapArray, wrapCollection, wrapProfileGroups, wrapSelfServiceAudienceCollection

Methods inherited from class atg.svc.ui.formhandlers.test.TreeTableDelegatingFormHandler

getOperation, getParameters, getState, getTreeTableId, getView, handleResponse, setOperation, setParameters, setTreeTableId, setView, validate

Methods inherited from class atg.web.formhandlers.ApplicationFormHandler

addParameterToURLString, beforeGet, beforeSet, checkFormError, checkFormRedirect, checkFormSuccess, formHandlerBeforeGet, formHandlerBeforeSet, formHandlerInit, getErrorURL, getRedirectDelayMS, getString, getString, getString, getSuccessURL, getUserMessagesResourceBundle, handleCancel, processException, processException, processExceptionAndLog, processExceptionAndLog, redirect, setErrorURL, setRedirectDelayMS, setSuccessURL, setUserMessagesResourceBundle

Methods inherited from class atg.droplet.TransactionalFormHandler

afterSet, commitTransaction, getTransactionDemarcation, isEnsureTransaction, isRollbackTransaction, isTransactionMarkedAsRollback, setEnsureTransaction, setRollbackTransaction, setTransactionDemarcation

Methods inherited from class atg.droplet.GenericFormHandler

addFormException, createFormSubmissionMessage, getCancelURL, getCheckForValidSession, getFormError, getFormExceptions, getFormName, getMessagePort, getMessageSource, getMessageType, getPropertyExceptions, getSendMessages, handleFormException, isRestorableForm, isValidSession, resetFormExceptions, setCancelURL, setCheckForValidSession, setFormName, setMessagePort, setMessageSource, setMessageType, setRestorableForm, setSendMessages

Methods inherited from class atg.droplet.EmptyFormHandler

afterGet

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingWarning, setServiceInfo, startService, stopService

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

mTopicService

protected TopicService mTopicService

Constructor Detail

TopicChooserFormHandler

public TopicChooserFormHandler()

Method Detail

getTopicService

public TopicService getTopicService()

setTopicService

public void setTopicService(TopicService pTopicService)

getItemDepth

public int getItemDepth(java.lang.Object pItem)

Implementation of Expandable interface.

Specified by:

getItemDepth in interface Expandable

Overrides:

getItemDepth in class OrgChooserFormHandler

Parameters:

pItem - Item object of "items" collection of tree table.

Returns:

Level of this topic in overall topic tree.

getItemHasChildren

public boolean getItemHasChildren(java.lang.Object pItem)

Implementation of Expandable interface.

Specified by:

getItemHasChildren in interface Expandable

Overrides:

getItemHasChildren in class OrgChooserFormHandler

Parameters:

pItem - Topic object of "items" collection of tree table.

Returns:

true if topic has subtopics; false otherwise.

getViewItems

public java.util.List getViewItems()

Create collection of visible organization items.

Specified by:

getViewItems in interface Listable

Overrides:

getViewItems in class OrgChooserFormHandler

Returns:

created collection of organization.

getSubOrganizations

public java.util.List getSubOrganizations(java.lang.String pItemKey)

Overrides:

getSubOrganizations in class OrgChooserFormHandler

Parameters:

pItemKey - ID of the topic

Returns:

List of subtopics

getChildren

public java.util.List getChildren(java.lang.String pItemKey)

Parameters:

pItemKey - ID of the topic

Returns:

List of subtopics

getSelectedKeysList

public java.util.List getSelectedKeysList()

Made to preserve sorting of mViewItems

Overrides:

getSelectedKeysList in class ListChooserFormHandler

Returns:

keys of all selected items to allow iteration.

prepareSelectedList

protected java.util.List prepareSelectedList(java.util.Collection repositoryItems,
                                             java.lang.String propertyName)

Overrides:

prepareSelectedList in class ListChooserFormHandler

Parameters:

repositoryItems - list of items whose display names should be include in result

Returns:

Display names of specified items.

getItemName

public java.lang.String getItemName()

Overrides:

getItemName in class ListChooserFormHandler