com.wewebu.ow.server.app

Interface OwComboboxRenderer

All Known Implementing Classes:

OwBaseComboboxRenderer, OwClassicComboboxRenderer, OwExtJSComboboxRenderer

public interface OwComboboxRenderer

Combo box renderer component interface.

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

Since:

3.0.0.0

Method Summary

Methods

Modifier and Type	Method and Description
void	addEvent(String eventName_p, String eventHandler_p) Add JavaScript code for the given event name
void	addStyleClass(String styleClass_p) Add specified style class.
void	addStyleClass(String styleClass_p, boolean ignoreDefaultStyleClasses_p) Add specific style class.
void	addStyleClasses(String[] styleClasses_p) Add a list of style classes, to be rendered with this component.
void	addStyleClasses(String[] styleClasses_p, boolean ignoreDefaultStyleClasses_p) Add a list of style classes, to be rendered with this component.
String[]	getAllEventsNames() Get all event names for this combo
void	renderCombo(Writer writer_p) Render the combobox on a Writer object.
void	setContext(OwMainAppContext context_p) Set the context.
void	setEnabled(boolean enabled_p) Set the enabled status of this combobox.
void	setFieldDefinition(OwFieldDefinition fieldDefinition_p) Set the field definition.
void	setFieldDescription(OwString description_p) Set the description of the rendered field.
void	setFieldId(String fieldId_p) Set the id of the rendered field.
void	setFieldProvider(OwFieldProvider fieldProvider_p) Set the field provider.
void	setModel(OwComboModel model_p) Set the combo model items.

Method Detail

renderCombo

void renderCombo(Writer writer_p)
                 throws Exception

Render the combobox on a Writer object.

Parameters:

writer_p - - the writer object.

Throws:

Exception

addStyleClass

void addStyleClass(String styleClass_p)

Add specified style class.

Parameters:

styleClass_p - - thestyle class.

addStyleClass

void addStyleClass(String styleClass_p,
                 boolean ignoreDefaultStyleClasses_p)

Add specific style class. If the parameter ignoreDefaultStyleClasses_p is true the default style classes are not rendered anymore

Parameters:

styleClass_p - - the name of the style class

ignoreDefaultStyleClasses_p - - if has true value, the default style classes are not rendered anymore

addStyleClasses

void addStyleClasses(String[] styleClasses_p)

Add a list of style classes, to be rendered with this component.

Parameters:

styleClasses_p - - the array of String objects, representing the style classes.

addStyleClasses

void addStyleClasses(String[] styleClasses_p,
                   boolean ignoreDefaultStyleClasses_p)

Add a list of style classes, to be rendered with this component.

Parameters:

styleClasses_p - - the array of String objects, representing the style classes.

ignoreDefaultStyleClasses_p - - if has true value, the default style classes are not rendered anymore

addEvent

void addEvent(String eventName_p,
            String eventHandler_p)

Add JavaScript code for the given event name

Parameters:

eventName_p - - the event name

eventHandler_p - - the JavaScript event handler. Please use " for JS string delimiter.

getAllEventsNames

String[] getAllEventsNames()

Get all event names for this combo

Returns:

an array of String objects, representing the event names.

setContext

void setContext(OwMainAppContext context_p)

Set the context.

Parameters:

context_p - - the OwMainAppContext object.

setModel

void setModel(OwComboModel model_p)

Set the combo model items.

Parameters:

model_p - - the OwComboModel object.

setFieldId

void setFieldId(String fieldId_p)

Set the id of the rendered field.

Parameters:

fieldId_p - - the String object representing the ID to be rendered as htmlid value

setFieldDescription

void setFieldDescription(OwString description_p)

Set the description of the rendered field.

Parameters:

description_p - - the OwString object representing the description of the rendered combo controls (usually as title HTML attribute values)

setFieldDefinition

void setFieldDefinition(OwFieldDefinition fieldDefinition_p)

Set the field definition.

Parameters:

fieldDefinition_p - - the OwFieldDefinition object.

setFieldProvider

void setFieldProvider(OwFieldProvider fieldProvider_p)

Set the field provider.

Parameters:

fieldProvider_p - - the OwFieldProvider object.

setEnabled

void setEnabled(boolean enabled_p)

Set the enabled status of this combobox.

Parameters:

enabled_p -

Since:

3.1.0.0