er.modern.directtoweb.components

Class ERMD2WColumnSelector

java.lang.Object

com.webobjects.appserver.WOElement

com.webobjects.appserver.WOComponent

er.extensions.components.ERXComponent

er.extensions.components.ERXNonSynchronizingComponent

er.directtoweb.components.ERDCustomComponent

er.modern.directtoweb.components.ERMD2WColumnSelector

All Implemented Interfaces:

WOActionResults, NSKeyValueCoding, NSKeyValueCoding.ErrorHandling, NSKeyValueCodingAdditions, NSValidation, ERXExceptionHolder, Serializable, Cloneable

public class ERMD2WColumnSelector
extends ERDCustomComponent

Adds a small drop-down menu to list table headers to allow the user a choice of which columns should be displayed. The choices made are persisted via the ERCoreBusinessLogic preferences system. To enable it, add a rule like the following:

100 : *true* => showColumnSelector = "true"
 [com.webobjects.directtoweb.BooleanAssignment]

By default the component is placed in the right action block and falls back to the left when no right action block is being displayed.

See Also:

Serialized Form

Author:

fpeters

Nested Class Summary

Nested classes/interfaces inherited from class er.directtoweb.components.ERDCustomComponent

ERDCustomComponent.Keys

Nested classes/interfaces inherited from class com.webobjects.appserver.WOComponent

WOComponent._EventLoggingEnabler, WOComponent.Event

Nested classes/interfaces inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions

NSKeyValueCodingAdditions.DefaultImplementation, NSKeyValueCodingAdditions.Utility

Nested classes/interfaces inherited from interface com.webobjects.foundation.NSKeyValueCoding

NSKeyValueCoding._BooleanFieldBinding, NSKeyValueCoding._BooleanMethodBinding, NSKeyValueCoding._FieldBinding, NSKeyValueCoding._ForwardingBinding, NSKeyValueCoding._KeyBinding, NSKeyValueCoding._KeyBindingCreation, NSKeyValueCoding._MethodBinding, NSKeyValueCoding._NumberFieldBinding, NSKeyValueCoding._NumberMethodBinding, NSKeyValueCoding._ReflectionKeyBindingCreation, NSKeyValueCoding.ErrorHandling, NSKeyValueCoding.MapImplementation, NSKeyValueCoding.Null<T>, NSKeyValueCoding.UnknownKeyException, NSKeyValueCoding.ValueAccessor

Nested classes/interfaces inherited from interface com.webobjects.foundation.NSValidation

NSValidation._MethodBinding, NSValidation._ValidationBinding, NSValidation.DefaultImplementation, NSValidation.Utility, NSValidation.ValidationException

Field Summary

Fields

Modifier and Type	Field and Description
String	aPropertyKey
ERD2WContainer	currentSection

Fields inherited from class er.directtoweb.components.ERDCustomComponent

extraBindings, FALSE, log, TRUE

Fields inherited from class er.extensions.components.ERXComponent

_dynamicBindings

Fields inherited from class com.webobjects.appserver.WOComponent

_Extension, _IsEventLoggingEnabled, _keyAssociations

Fields inherited from interface com.webobjects.foundation.NSKeyValueCoding.ErrorHandling

_CLASS

Fields inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions

_CLASS, _KeyPathSeparatorChar, KeyPathSeparator

Fields inherited from interface com.webobjects.foundation.NSKeyValueCoding

NullValue

Fields inherited from interface com.webobjects.foundation.NSValidation

_CLASS

Constructor Summary

Constructors

Constructor and Description
ERMD2WColumnSelector(WOContext aContext)

Method Summary

Modifier and Type	Method and Description
String	columnSelectorClass()
NSArray	currentSectionKeys()
String	displayNameForProperty()
String	displayVariant() Gets the displayVariant for the current property key.
boolean	isShowColumnSelector()
String	propertyKey()
NSArray	sectionsContents()
void	setPropertyKey(String propertyKey)
WOActionResults	toggleColumnVisibility()

Methods inherited from class er.directtoweb.components.ERDCustomComponent

appendToResponse, clearValidationFailed, d2wComponentNameDebuggingEnabled, d2wContext, d2wContextFromBindings, d2wContextValueForBinding, d2wDebuggingEnabled, d2wPage, d2wPropertyKeyDebuggingEnabled, extraBindings, extraBindingsValueForBinding, hasBinding, integerBooleanForBinding, key, localContext, logDebugInfo, originalValueForBinding, parentValueForBinding, reset, resetCachedBindingsInStatefulComponent, setD2wContext, setExtraBindings, setKey, setLocalContext, synchronizesVariablesWithBindings, task, taskIsEdit, taskIsInspect, taskIsList, validationFailedWithException, valueForBinding

Methods inherited from class er.extensions.components.ERXNonSynchronizingComponent

invokeAction, takeValuesFromRequest

Methods inherited from class er.extensions.components.ERXComponent

_awakeInContext, _checkAccess, _frameworkName, _includeCSSResources, _includeJavascriptResources, additionalCSSFiles, additionalJavascriptFiles, arrayValueForBinding, arrayValueForBinding, booleanValueForBinding, booleanValueForBinding, booleanValueForBinding, browser, checkAccess, clickToOpenEnabled, componentName, defaultCSSPath, defaultJavascriptPath, dynamicBindings, floatValueForBinding, intValueForBinding, isPageAccessAllowed, localizer, objectValueForBinding, objectValueForBinding, pageWithName, postAppendToResponse, preAppendToResponse, primaryCSSFile, primaryJavascriptFile, shouldCheckAccess, stringValueForBinding, stringValueForBinding, useDefaultComponentCSS, useDefaultComponentJavascript

Methods inherited from class com.webobjects.appserver.WOComponent

__valueForBinding, _associationWithName, _childTemplate, _cleanUpStatelessComponent, _componentDefinition, _componentUnroll, _isPage, _setContext, _setIsPage, _setParent, _setSubcomponent, _sleepInContext, _subcomponentForElementWithID, _templateNameForClass, _unroll, application, awake, baseURL, bindingKeys, canAccessFieldsDirectly, canGetValueForBinding, canSetValueForBinding, clone, context, debugString, descriptionForResponse, ensureAwakeInContext, frameworkName, generateResponse, handleQueryWithUnboundKey, handleTakeValueForUnboundKey, hasSession, isCachingEnabled, isEventLoggingEnabled, isStateless, logString, name, pageWithName, parent, path, pathURL, performParentAction, pullValuesFromParent, pushValuesToParent, session, set_componentUnroll, set_unroll, setCachingEnabled, setValueForBinding, setVariableValueForName, sleep, takeValueForKey, takeValueForKeyPath, template, templateWithHTMLString, templateWithHTMLString, templateWithHTMLString, templateWithName, toString, unableToSetNullForKey, validateTakeValueForKeyPath, validateValueForKey, valueForBooleanBinding, valueForIntegerBinding, valueForKey, valueForKeyPath, valueForNSArrayBindings, valueForNSDictionaryBindings, valueForNumberBinding, valueForStringBinding, variableValueForName, variableWithName

Methods inherited from class java.lang.Object

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

Field Detail

aPropertyKey

public String aPropertyKey

currentSection

public ERD2WContainer currentSection

Constructor Detail

ERMD2WColumnSelector

public ERMD2WColumnSelector(WOContext aContext)

Method Detail

sectionsContents

public NSArray sectionsContents()

currentSectionKeys

public NSArray currentSectionKeys()

propertyKey

public String propertyKey()

setPropertyKey

public void setPropertyKey(String propertyKey)

toggleColumnVisibility

public WOActionResults toggleColumnVisibility()

displayNameForProperty

public String displayNameForProperty()

displayVariant

public String displayVariant()

Gets the displayVariant for the current property key. The intention is that the display variant allows variation in the display method of property keys without needing different, slightly varying, displayPropertyKeys or tabSectionsContents rules. Template support has been added for the omit and blank variants. One could imagine others, such as collapsed, ajax, etc.

Returns:

the display variant, if specified

columnSelectorClass

public String columnSelectorClass()

isShowColumnSelector

public boolean isShowColumnSelector()