com.skratchdot.electribe.model.esx.presentation

Class EsxComposite

java.lang.Object

Composite

com.skratchdot.electribe.model.esx.presentation.EsxComposite

Direct Known Subclasses:

EsxCompositeGlobal, EsxCompositeGlobalMidiCC, EsxCompositeGlobalNoteNumbers, EsxCompositeGlobalPatternSets, EsxCompositePattern, EsxCompositePatternFx, EsxCompositePatternMotionSequences, EsxCompositePatternParts, EsxCompositeSample, EsxCompositeSampleInPatternInfo, EsxCompositeSong, EsxCompositeSongEvents, EsxCompositeSongPatterns

public abstract class EsxComposite
extends Composite

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ID
protected boolean	isActive
protected EsxEditorPart	parentPart

Constructor Summary

Constructors

Constructor and Description
EsxComposite(Composite parent, int style)
EsxComposite(EsxEditorPart parentPart, Composite parentComposite, int style)

Method Summary

Methods

Modifier and Type	Method and Description
protected Combo	createGridData2ColumnComboInput(Composite parent, java.lang.String title, java.lang.String[] comboItems, SelectionAdapter selectionAdapter)
protected void	createGridData2ColumnSpacer(Composite parent)
protected Text	createGridData2ColumnTextInput(Composite parent, java.lang.String title, SelectionAdapter selectionAdapter)
protected Text	createGridData2ColumnTextLabel(Composite parent, java.lang.String title)
protected Button	createGridData4ColumnCheckButton(Composite parent, java.lang.String title, boolean setSelection)
protected AdapterFactory	getAdapterFactory()
protected BasicCommandStack	getCommandStack()
protected int	getCountInListWithValue(java.util.List<? extends EObject> list, EStructuralFeature feature, java.lang.Object value)
EditingDomain	getEditingDomain()
protected java.util.List<? extends EObject>	getListOfEObjectsWithinEObject(java.util.List<? extends EObject> list, EStructuralFeature feature) This is shorthand for calling getListOfEObjectsWithinEObject(List, EStructuralFeature, int) with a -1 for featureIndex.
protected java.util.List<? extends EObject>	getListOfEObjectsWithinEObject(java.util.List<? extends EObject> list, EStructuralFeature feature, int featureIndex)
protected java.lang.String[]	getLiteralStrings(Enumerator[] enumArray)
protected java.lang.String[]	getLiteralStrings(int startValue, int length)
protected java.lang.String	getMultiNumberString(java.lang.String string, int currentIndex, int listSize, int maxAppendStringLength) This function is intended to be called from within a loop, passing a different currentIndex each time.
protected java.lang.String	getMultiString(java.util.List<? extends EObject> list, EStructuralFeature featureOne, int featureOneIndex, EStructuralFeature featureTwo, java.lang.String multiText)
protected java.lang.String	getMultiString(java.util.List<? extends EObject> list, EStructuralFeature feature, java.lang.String multiText) This takes a list of EObjects and compares the given feature's toString() values.
protected java.lang.String	getMultiString(java.util.List<? extends EObject> list, EStructuralFeature feature, java.lang.String multiText, EStructuralFeature featureLabel) This takes a list of EObjects and compares the given feature's toString() values.
protected java.lang.String	getMultiStringPatternLabels(java.util.List<? extends EObject> list, EStructuralFeature feature, java.lang.String multiText)
protected java.lang.String[]	getPatternLabelStrings()
abstract void	refresh() Refreshes this component with information freshly obtained from the component's model.
abstract void	refreshInputs() This method is similar to the refresh() method, but it should typically only be called with setInput() is called.
protected void	setFeatureForSelectedItems(java.util.List<? extends EObject> list, EStructuralFeature feature, java.lang.Object value, boolean appendNumber, int maxAppendStringLength)
abstract void	setInput(java.lang.Object input) Sets the input to this component.

Methods inherited from class java.lang.Object

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

Field Detail

ID

public static final java.lang.String ID

See Also:

Constant Field Values

parentPart

protected EsxEditorPart parentPart

isActive

protected boolean isActive

Constructor Detail

EsxComposite

public EsxComposite(Composite parent,
            int style)

Parameters:

parent -

style -

EsxComposite

public EsxComposite(EsxEditorPart parentPart,
            Composite parentComposite,
            int style)

Parameters:

parentPart -

parentComposite -

style -

Method Detail

setInput

public abstract void setInput(java.lang.Object input)

Sets the input to this component. This method simply updates the internal member variables of the component.

Parameters:

input -

refresh

public abstract void refresh()

Refreshes this component with information freshly obtained from the component's model. This method is called by the main editor whenever a command on the command stack has been called. It is up to the subclasses to determine what needs to be refreshed.

refreshInputs

public abstract void refreshInputs()

This method is similar to the refresh() method, but it should typically only be called with setInput() is called. It's goal is to refresh any "form inputs".

getEditingDomain

public EditingDomain getEditingDomain()

getCommandStack

protected BasicCommandStack getCommandStack()

Returns:

getAdapterFactory

protected AdapterFactory getAdapterFactory()

Returns:

getPatternLabelStrings

protected java.lang.String[] getPatternLabelStrings()

Returns:

getMultiStringPatternLabels

protected java.lang.String getMultiStringPatternLabels(java.util.List<? extends EObject> list,
                                           EStructuralFeature feature,
                                           java.lang.String multiText)

Parameters:

list - A list of EObjects

feature - The feature to compare

multiText - The String to return if the given features toString() values don't match

Returns:

getMultiString

protected java.lang.String getMultiString(java.util.List<? extends EObject> list,
                              EStructuralFeature feature,
                              java.lang.String multiText)

This takes a list of EObjects and compares the given feature's toString() values. If the list is empty, an empty string is returned. If the list only contains one item, or if all the feature's toString() valus match, then the toString() value is returned. If there are differing values for toString(), then the param "multiText" is returned.

Parameters:

list - A list of EObjects

feature - The feature to compare

multiText - The String to return if the given features toString() values don't match

Returns:

getMultiString

protected java.lang.String getMultiString(java.util.List<? extends EObject> list,
                              EStructuralFeature featureOne,
                              int featureOneIndex,
                              EStructuralFeature featureTwo,
                              java.lang.String multiText)

Parameters:

list - A list of EObjects

featureOne - The main feature. Should be an Elist.

featureOneIndex - The index of featureOne.

featureTwo - Look in featureOne.get(featureOneIndex) for featureTwo.

multiText - The String to return if the given features toString() values don't match

Returns:

getMultiString

protected java.lang.String getMultiString(java.util.List<? extends EObject> list,
                              EStructuralFeature feature,
                              java.lang.String multiText,
                              EStructuralFeature featureLabel)

This takes a list of EObjects and compares the given feature's toString() values. If the list is empty, an empty string is returned. If the list only contains one item, or if all the feature's toString() values match, then the toString() value is returned. If there are differing values for toString(), then the param "multiText" is returned. If feature is a complex object, then featureLabel can be used to return a more appropriate label.

Parameters:

list - A list of EObjects

feature - The feature to compare

multiText - The String to return if the given features toString() values don't match

featureLabel - Can be null, or a "sub-feature" of feature.

Returns:

getMultiNumberString

protected java.lang.String getMultiNumberString(java.lang.String string,
                                    int currentIndex,
                                    int listSize,
                                    int maxAppendStringLength)

This function is intended to be called from within a loop, passing a different currentIndex each time. It will return the given string with a number appended to the end of it.

Parameters:

string - The string to append a number to

currentIndex - The current index (the number appended will be currentIndex+1)

listSize - The total size of the list you are appending numbers to

maxAppendStringLength - The maximum length of the string that is returned

Returns:

getCountInListWithValue

protected int getCountInListWithValue(java.util.List<? extends EObject> list,
                          EStructuralFeature feature,
                          java.lang.Object value)

Parameters:

list - A list of EObjects

feature - The feature to compare

value - The value to compare

Returns:

Returns the count of features in the given list that are equal to the given value

setFeatureForSelectedItems

protected void setFeatureForSelectedItems(java.util.List<? extends EObject> list,
                              EStructuralFeature feature,
                              java.lang.Object value,
                              boolean appendNumber,
                              int maxAppendStringLength)

Parameters:

list - A list of EObjects

feature - The feature we will be setting

value - The value we will be setting

appendNumber - If true, then we will attempt to append a number to the end of value (value should be a string)

maxAppendStringLength - Only used if appendNumber is true. This is the maxlength of the string we are trying to append to

getListOfEObjectsWithinEObject

protected java.util.List<? extends EObject> getListOfEObjectsWithinEObject(java.util.List<? extends EObject> list,
                                                               EStructuralFeature feature)

This is shorthand for calling getListOfEObjectsWithinEObject(List, EStructuralFeature, int) with a -1 for featureIndex.

Parameters:

list - A list of EObjects

feature - The feature to look for within each EObject

Returns:

Returns a List of EObjects.

getListOfEObjectsWithinEObject

protected java.util.List<? extends EObject> getListOfEObjectsWithinEObject(java.util.List<? extends EObject> list,
                                                               EStructuralFeature feature,
                                                               int featureIndex)

Parameters:

list - A list of EObjects

feature - The feature to look for within each EObject

featureIndex - If this is specified, then the feature is an EList. This is the index of the feature.

Returns:

Returns a List of EObjects.

createGridData2ColumnSpacer

protected void createGridData2ColumnSpacer(Composite parent)

Parameters:

parent -

createGridData2ColumnTextLabel

protected Text createGridData2ColumnTextLabel(Composite parent,
                                  java.lang.String title)

Parameters:

parent -

title -

Returns:

createGridData2ColumnTextInput

protected Text createGridData2ColumnTextInput(Composite parent,
                                  java.lang.String title,
                                  SelectionAdapter selectionAdapter)

Parameters:

parent -

title -

selectionAdapter -

Returns:

createGridData2ColumnComboInput

protected Combo createGridData2ColumnComboInput(Composite parent,
                                    java.lang.String title,
                                    java.lang.String[] comboItems,
                                    SelectionAdapter selectionAdapter)

Parameters:

parent -

title -

comboItems -

selectionAdapter -

Returns:

createGridData4ColumnCheckButton

protected Button createGridData4ColumnCheckButton(Composite parent,
                                      java.lang.String title,
                                      boolean setSelection)

Parameters:

parent -

title -

setSelection -

Returns:

getLiteralStrings

protected java.lang.String[] getLiteralStrings(Enumerator[] enumArray)

Parameters:

enumArray -

Returns:

getLiteralStrings

protected java.lang.String[] getLiteralStrings(int startValue,
                                   int length)

Parameters:

startValue - The first value in our string array.

length - Must be a postive value or else an error is thrown

Returns:

Returns a string array of values, starting at startValue, and ending in startValue+length