com.tssap.util.ui.reuse.checkbox
Class CheckboxComponent

java.lang.Object
  |
  +--com.tssap.util.ui.AbstractEditable
        |
        +--com.tssap.util.ui.reuse.GenericComponent
              |
              +--com.tssap.util.ui.reuse.HandleDropDownSelectors
                    |
                    +--com.tssap.util.ui.reuse.checkbox.CheckboxComponent

All Implemented Interfaces:

ICheckboxComponent, IEditable, IGenericComponent, IGridLayoutPaneContainer, IReuseable

public class CheckboxComponent

extends HandleDropDownSelectors

implements ICheckboxComponent, IReuseable

Copyright: Copyright (c) 2002 Company: SAP AG

Since:

17.09.2002 Generic component consisting of a checkbox and an array of DropDownSelector components.

Constructor Summary

CheckboxComponent(java.lang.String initialTitle, boolean initialChecked, ITextChooser[] initialTextChoosers, java.lang.String initialCboxLabel)

Method Summary

java.lang.String	getCheckboxLabel()
boolean	getChecked()
ITextChooser	getTextChooser(int index)
ITextChooser[]	getTextChoosers()
int	getUserGridNumOfColumns() Returns number of columns for userArea given to method initContainer(IGridLayoutPane userArea)
void	initContainer(IGridLayoutPane userArea) Initialize component's UI.
boolean	isChecked()
boolean	isUserGridEqualColSize() Returns true if userArea given to method initContainer(IGridLayoutPane userArea) has to have equal column widths
void	refresh() Update component's UI
void	setCheckboxLabel(java.lang.String initialCboxLabel)
void	setChecked(boolean initialChecked)
void	setEnabled(boolean enabled) Set whether or not the component and all its subcomponents are enabled.
void	setInitialSelectorHasPushButton(boolean selectorHasPushButton) Sets the selectorHasPushButton.
void	setSelectorHasPushButton(boolean selectorHasPushButton) Sets the selectorHasPushButton.
void	setTextChooser(ITextChooser initialTextChooser, int index)
void	setTextChoosers(ITextChooser[] initialTextChoosers) When calling this method after having called createPartControl changes will occur only with few of the TextChoosers' parameters!

Methods inherited from class com.tssap.util.ui.reuse.GenericComponent

addModifyListener, addSelectionListener, createPartControl, createPartControl, createPartControl, getTitle, getUserAreaGridLayoutPane, isComposable, isEnabled, removeModifyListener, removeSelectionListener, setTitle

Methods inherited from class com.tssap.util.ui.AbstractEditable

isEditable, setEditable

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.tssap.util.ui.reuse.IGenericComponent

addModifyListener, addSelectionListener, createPartControl, createPartControl, getTitle, removeModifyListener, removeSelectionListener, setTitle

Methods inherited from interface com.tssap.util.ui.IEditable

isEditable, setEditable

Methods inherited from interface com.tssap.util.ui.reuse.IReuseable

createPartControl, isEnabled

Constructor Detail

CheckboxComponent

public CheckboxComponent(java.lang.String initialTitle,
                         boolean initialChecked,
                         ITextChooser[] initialTextChoosers,
                         java.lang.String initialCboxLabel)

Method Detail

initContainer

public void initContainer(IGridLayoutPane userArea)

Description copied from interface: IGridLayoutPaneContainer

Initialize component's UI. Implementor has to fill the given grid layout pane. The number of columns comes from call to method getUserGridNumOfColumns(). If grid columns have equal widths is decided through call to isUserGridEqualColSize().

Specified by:

initContainer in interface IGridLayoutPaneContainer

See Also:

IGridLayoutPaneContainer.initContainer(IGridLayoutPane)

isUserGridEqualColSize

public boolean isUserGridEqualColSize()

Description copied from interface: IGridLayoutPaneContainer

Returns true if userArea given to method initContainer(IGridLayoutPane userArea) has to have equal column widths

Specified by:

isUserGridEqualColSize in interface IGridLayoutPaneContainer

See Also:

IGridLayoutPaneContainer.isUserGridEqualColSize()

getUserGridNumOfColumns

public int getUserGridNumOfColumns()

Description copied from interface: IGridLayoutPaneContainer

Returns number of columns for userArea given to method initContainer(IGridLayoutPane userArea)

Specified by:

getUserGridNumOfColumns in interface IGridLayoutPaneContainer

See Also:

IGridLayoutPaneContainer.getUserGridNumOfColumns()

refresh

public void refresh()

Description copied from interface: IGenericComponent

Update component's UI

Specified by:

refresh in interface IGenericComponent

Overrides:

refresh in class GenericComponent

getTextChoosers

public ITextChooser[] getTextChoosers()

Specified by:

getTextChoosers in interface ICheckboxComponent

See Also:

ICheckboxComponent.getTextChoosers()

isChecked

public boolean isChecked()

Specified by:

isChecked in interface ICheckboxComponent

See Also:

com.tssap.util.ui.reuse.checkbox.ICheckboxComponent#initialChecked()

getCheckboxLabel

public java.lang.String getCheckboxLabel()

Specified by:

getCheckboxLabel in interface ICheckboxComponent

setChecked

public void setChecked(boolean initialChecked)

Specified by:

setChecked in interface ICheckboxComponent

See Also:

ICheckboxComponent.setChecked(boolean)

setCheckboxLabel

public void setCheckboxLabel(java.lang.String initialCboxLabel)

Specified by:

setCheckboxLabel in interface ICheckboxComponent

See Also:

ICheckboxComponent.setCheckboxLabel(String)

getTextChooser

public ITextChooser getTextChooser(int index)

Specified by:

getTextChooser in interface ICheckboxComponent

See Also:

ICheckboxComponent.getTextChooser(int)

setTextChooser

public void setTextChooser(ITextChooser initialTextChooser,
                           int index)

Specified by:

setTextChooser in interface ICheckboxComponent

Parameters:

initialTextChooser - the TextChooser to set

index - - which TextChooser of an array of TextChoosers is meant

See Also:

ICheckboxComponent.setTextChooser(ITextChooser, int)

setTextChoosers

public void setTextChoosers(ITextChooser[] initialTextChoosers)

When calling this method after having called createPartControl changes will occur only with few of the TextChoosers' parameters! So most of the TextChoosers' parameters can be null. Use the setter methods for these few parameters instead.

Specified by:

setTextChoosers in interface ICheckboxComponent

Parameters:

ITextChooser[] - initialTextChoosers

See Also:

new Choosers length has to be the same as the initial choosers length!, com.tssap.util.ui.reuse.checkbox.ICheckboxComponent#setTextChooser(ITextChooserArray)

getChecked

public boolean getChecked()

setEnabled

public void setEnabled(boolean enabled)

Description copied from interface: IReuseable

Set whether or not the component and all its subcomponents are enabled.

Specified by:

setEnabled in interface IReuseable

Overrides:

setEnabled in class GenericComponent

See Also:

IReuseable.setEnabled(boolean)

setSelectorHasPushButton

public void setSelectorHasPushButton(boolean selectorHasPushButton)

Sets the selectorHasPushButton. Calling this method after having called createPartControl(..) will throw an exception!

Specified by:

setSelectorHasPushButton in interface ICheckboxComponent

Parameters:

selectorHasPushButton - The selectorHasPushButton to set

setInitialSelectorHasPushButton

public void setInitialSelectorHasPushButton(boolean selectorHasPushButton)

Sets the selectorHasPushButton.

Parameters:

selectorHasPushButton - The selectorHasPushButton to set