com.sapportals.htmlb.toolbar

Class Toolbar

java.lang.Object
  com.sapportals.htmlb.Component
      com.sapportals.htmlb.Container
          com.sapportals.htmlb.toolbar.Toolbar

public class Toolbar

extends Container

Field Summary

static String

UI_ID

Fields inherited from class com.sapportals.htmlb.Container

elements

Constructor Summary

Toolbar(String name)
creates a toolbar with a specific name

Method Summary

Component	addComponent(Component component) add a toolbar item to the toobar.
ToolbarButton	addToolbarButton(String id, String text) creates a new ToolbarButton and adds it to the toolbar
ToolbarDropDownListBox	addToolbarDropDownListBox(String id) creates a new ToolbarDropDownListBox and adds it to the toolbar
ToolbarInputField	addToolbarInputField(String id) creates a new ToolbarInputField and adds it to the toolbar
ToolbarSeparator	addToolbarSeparator() creates a new ToolbarSeparator and adds it to the toolbar
String	getAccessibilityDescription() get the semantical description of the component in it's applicationcontext used by screenreaders
ToolbarDesign	getDesign() returns the design for the toolbar
String	getUI() get a identification String for the renderer that is unique across all supported components.
void	setAccessibilityDescription(String accessibilityDescription) sets the sematical description for the component in it's applicationcontext used by screenreaders
void	setDesign(ToolbarDesign design) sets the design for the toolbar

Methods inherited from class com.sapportals.htmlb.Container

addRawText, addText, getChildCount, iterator, preRender, removeComponent, render

Methods inherited from class com.sapportals.htmlb.Component

getEncodedIdForForm, getId, getParent, initFromPageContext, initFromShortId, initializeFromId, isJsObjectNeeded, render, renderAsString, requiresForm, setId, setJsObjectNeeded, setParent

Methods inherited from class java.lang.Object

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

Field Detail

UI_ID

public static final String UI_ID

See Also:

Constant Field Values

Constructor Detail

Toolbar

public Toolbar(String name)

creates a toolbar with a specific name

Parameters:

name - the name/ID for this toolbar

Method Detail

addComponent

public Component addComponent(Component component)

add a toolbar item to the toobar. The component to be added must be of type ToolbarButton, ToolbarDropDownListBox, ToolbarInputField or ToolbarSeparator

Overrides:

addComponent in class Container

Parameters:

component - the component to add

addToolbarButton

public ToolbarButton addToolbarButton(String id,
                                      String text)

creates a new ToolbarButton and adds it to the toolbar

Parameters:

id - the id for the toolbarbutton

text - the text for the toolbarbutton

Returns:

the new toolbarbutton

addToolbarInputField

public ToolbarInputField addToolbarInputField(String id)

creates a new ToolbarInputField and adds it to the toolbar

Parameters:

id - the id for the toolbarbutton

Returns:

the new ToolbarInputField

addToolbarSeparator

public ToolbarSeparator addToolbarSeparator()

creates a new ToolbarSeparator and adds it to the toolbar

Returns:

the new toolbarseparator

addToolbarDropDownListBox

public ToolbarDropDownListBox addToolbarDropDownListBox(String id)

creates a new ToolbarDropDownListBox and adds it to the toolbar

Parameters:

id - the id for the toolbardropdownlistbox

Returns:

the new toolbardropdownlistbox

getDesign

public ToolbarDesign getDesign()

returns the design for the toolbar

Returns:

the toolbar design

setDesign

public void setDesign(ToolbarDesign design)

sets the design for the toolbar

Parameters:

design - the toolbar design

getUI

public String getUI()

get a identification String for the renderer that is unique across all supported components. E.g. you could simply return the class name of the component class. The reason for using a separate method and not some internal reflection method is that you can more easily extend the functionality or your Component class without having to rewrite the view class.

Specified by:

getUI in class Component

Returns:

a unique identification string for this Component

getAccessibilityDescription

public String getAccessibilityDescription()

get the semantical description of the component in it's applicationcontext used by screenreaders

Returns:

description text

setAccessibilityDescription

public void setAccessibilityDescription(String accessibilityDescription)

sets the sematical description for the component in it's applicationcontext used by screenreaders

Parameters:

accessibilityDescription - description text

Returns: