public class OwSettingsPropertySort extends OwSettingsPropertyBaseImpl
A single settings Sort property that can be configured to sort the columns.
Alfresco Workdesk
Copyright (c) Alfresco Software, Inc.
All rights reserved.
For licensing information read the license.txt file or
go to: http://wiki.alfresco.com
Modifier and Type | Field and Description |
---|---|
static boolean |
ASC_SORT_ORDER_FLAG
default sort order
|
protected static String |
COLUMN_INFO_NODE_NAME
node name in the setting set
|
protected static String |
COMBO_SELECT_ITEM_DISPLAY_ATTR_NAME
attribute name of a combo select item display name for list properties
|
protected static String |
COMBO_SELECT_ITEM_NODE_NAME
node name of a combo select item for list properties
|
protected static String |
SORT_ATTRIBUTE_NAME
attribute name of the property sort order
|
protected static String |
SORT_PREFIX
ID prefix for sort list values
|
ITEM_PREFIX, ITEM_QUERY_KEY, m_defaultValue, m_fList, m_strError, m_value
m_externalFormEventTarget, m_propertyDefinitionNode, m_strSetName
ITEM_VALUE_NODE
Constructor and Description |
---|
OwSettingsPropertySort() |
Modifier and Type | Method and Description |
---|---|
protected boolean |
canAdd()
check if additional items can be added to the list value
|
protected List |
createComboSelectList(OwSettingsProperty property_p)
create a list of values, if property is a list
|
protected Object |
createSingleClonedValue(Object oSingleValue_p)
create a clone out of the given single property value
|
protected List |
createValueList(Node valueNode_p)
create a list of values, if property is a list
|
protected Object |
getDefaultListItemValue()
overridable to create a default value for list properties
|
Node |
getValueNode(Document doc_p)
return the property value as a DOM Node for serialization
|
void |
init(Node propertyDefinitionNode_p,
Node valueNode_p,
String strSetName_p)
set current value of property, to be overridden
|
void |
insertFormField(Writer w_p)
insert the property into a HTML form for editing
|
protected void |
insertFormValue(Writer w_p,
Object value_p,
String strID_p,
int iIndex_p)
overridable to insert a single value into a edit HTML form
|
boolean |
isList()
get flag indicating list or scalar value
|
void |
onAdd(javax.servlet.http.HttpServletRequest request_p)
called when user clicked the add item button for a list property
|
boolean |
updateExternalFormTarget(javax.servlet.http.HttpServletRequest request_p,
boolean fSave_p)
update the target after a form event, so it can set its form fields
|
appendSingleValueNode, createValue, extractIDIndex, getMaxListSize, getPropertyError, getSafePropertyError, getSingleValue, getSingleValueFromRequest, getValue, hasError, insertLabel, insertLabelValue, isModified, onDelete, saved, setDefault, setValue, toString, writeAddNewItemButton, writeDeleteButton
getDisplayName, getFormName, getFormTarget, getHelpPath, getName, getPropertyDefinitionNode, init, isEditable, isUser, setExternalFormTarget
attach, detach, disableRequestListener, enableRequestListener, getAjaxEventURL, getContext, getEventURL, getFormEventFunction, getFormEventURL, getID, onExternalRequest, onFormEvent, onRequest
protected static final String COMBO_SELECT_ITEM_DISPLAY_ATTR_NAME
protected static final String COMBO_SELECT_ITEM_NODE_NAME
protected static final String COLUMN_INFO_NODE_NAME
protected static final String SORT_PREFIX
protected static final String SORT_ATTRIBUTE_NAME
public static final boolean ASC_SORT_ORDER_FLAG
public void init(Node propertyDefinitionNode_p, Node valueNode_p, String strSetName_p) throws Exception
OwSettingsPropertyBaseImpl
init
in interface OwSettingsProperty
init
in class OwSettingsPropertyBaseImpl
propertyDefinitionNode_p
- the node which defines the property in the plugin descriptors settingvalueNode_p
- the node with the current valuestrSetName_p
- name of the property set for which the property is createdException
protected List createValueList(Node valueNode_p)
OwSettingsPropertyBaseImpl
createValueList
in class OwSettingsPropertyBaseImpl
valueNode_p
- Node with child value nodespublic void onAdd(javax.servlet.http.HttpServletRequest request_p) throws Exception
OwSettingsPropertyBaseImpl
onAdd
in class OwSettingsPropertyBaseImpl
request_p
- HttpServletRequestException
protected boolean canAdd()
OwSettingsPropertyBaseImpl
canAdd
in class OwSettingsPropertyBaseImpl
protected Object createSingleClonedValue(Object oSingleValue_p)
OwSettingsPropertyBaseImpl
createSingleClonedValue
in class OwSettingsPropertyBaseImpl
oSingleValue_p
- single Object valuepublic boolean isList()
OwSettingsPropertyBaseImpl
isList
in class OwSettingsPropertyBaseImpl
public boolean updateExternalFormTarget(javax.servlet.http.HttpServletRequest request_p, boolean fSave_p) throws Exception
OwSettingsPropertyBaseImpl
updateExternalFormTarget
in class OwSettingsPropertyBaseImpl
request_p
- HttpServletRequestfSave_p
- boolean true = save the changes of the form data, false = just update the form data, but do not saveException
public void insertFormField(Writer w_p) throws Exception
OwSettingsPropertyBaseImpl
insertFormField
in class OwSettingsPropertyBaseImpl
w_p
- Writer to write HTML code toException
protected void insertFormValue(Writer w_p, Object value_p, String strID_p, int iIndex_p) throws Exception
OwSettingsPropertyBaseImpl
insertFormValue
in class OwSettingsPropertyBaseImpl
w_p
- Writer to write HTML code tovalue_p
- the property value to editstrID_p
- String the ID of the HTML element for use in onApplyiIndex_p
- int Index of item if it is a listException
public Node getValueNode(Document doc_p)
OwSettingsPropertyBaseImpl
getValueNode
in interface OwSettingsProperty
getValueNode
in class OwSettingsPropertyBaseImpl
doc_p
- DOM Document to add toprotected List createComboSelectList(OwSettingsProperty property_p) throws Exception
property_p
- Node with child value nodesException
protected Object getDefaultListItemValue() throws Exception
OwSettingsPropertyBaseImpl
getDefaultListItemValue
in class OwSettingsPropertyBaseImpl
Exception
Copyright © 2014 Alfresco Business Solutions. All Rights Reserved.