org.eclipse.scout.rt.client.ui.desktop.outline

Class AbstractOutlineViewButton

java.lang.Object

org.eclipse.scout.rt.platform.reflect.AbstractPropertyObserver

org.eclipse.scout.rt.client.ui.action.AbstractAction

org.eclipse.scout.rt.client.ui.action.view.AbstractViewButton

org.eclipse.scout.rt.client.ui.desktop.outline.AbstractOutlineViewButton

All Implemented Interfaces:

IAction, IViewButton, IOutlineViewButton, org.eclipse.scout.rt.platform.classid.ITypeWithClassId, org.eclipse.scout.rt.platform.IOrdered, org.eclipse.scout.rt.platform.reflect.IPropertyObserver, IExtensibleObject

public abstract class AbstractOutlineViewButton
extends AbstractViewButton
implements IOutlineViewButton

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractOutlineViewButton.LocalOutlineViewButtonExtension<OWNER extends AbstractOutlineViewButton>

Nested classes/interfaces inherited from class org.eclipse.scout.rt.client.ui.action.view.AbstractViewButton

AbstractViewButton.LocalViewButtonExtension<OWNER extends AbstractViewButton>

Nested classes/interfaces inherited from class org.eclipse.scout.rt.client.ui.action.AbstractAction

AbstractAction.LocalActionExtension<OWNER extends AbstractAction>, AbstractAction.P_UIFacade

Nested classes/interfaces inherited from interface org.eclipse.scout.rt.client.ui.action.view.IViewButton

IViewButton.DisplayStyle

Field Summary

Fields inherited from class org.eclipse.scout.rt.platform.reflect.AbstractPropertyObserver

propertySupport

Fields inherited from interface org.eclipse.scout.rt.client.ui.action.view.IViewButton

PROP_DISPLAY_STYLE

Fields inherited from interface org.eclipse.scout.rt.client.ui.action.IAction

HORIZONTAL_ALIGNMENT_LEFT, HORIZONTAL_ALIGNMENT_RIGHT, PROP_CONTAINER, PROP_ENABLED, PROP_HORIZONTAL_ALIGNMENT, PROP_ICON_ID, PROP_KEY_STROKE, PROP_MNEMONIC, PROP_SELECTED, PROP_TEXT, PROP_TEXT_WITH_MNEMONIC, PROP_TOOLTIP_TEXT, PROP_VIEW_ORDER, PROP_VISIBLE

Fields inherited from interface org.eclipse.scout.rt.platform.classid.ITypeWithClassId

ID_CONCAT_SYMBOL

Fields inherited from interface org.eclipse.scout.rt.platform.IOrdered

DEFAULT_ORDER, DEFAULT_ORDER_STEP

Constructor Summary

Constructors

Constructor and Description
AbstractOutlineViewButton(IDesktop desktop, Class<? extends IOutline> outlineType) call using AbstractDesktop.this or AbstractDesktopExtension#getDelegatingDesktop()

Method Summary

Modifier and Type	Method and Description
protected IOutlineViewButtonExtension<? extends AbstractOutlineViewButton>	createLocalExtension()
protected void	execAction() Activates the associated outline if it is not the desktop's active outline.
protected void	execInitAction() called by AbstractAction.initAction() this way a menu can for example add/remove custom child menus
protected boolean	getConfiguredEnabled() since execInitAction sets the value of this method to the value of the outline.
protected String	getConfiguredText() since execInitAction sets the value of this method to the value of the outline.
protected boolean	getConfiguredVisible() since execInitAction sets the value of this method to the value of the outline.
IDesktop	getDesktop()
IOutline	getOutline()

Methods inherited from class org.eclipse.scout.rt.client.ui.action.view.AbstractViewButton

getConfiguredDisplayStyle, getDisplayStyle, initConfig, setDisplayStyle

Methods inherited from class org.eclipse.scout.rt.client.ui.action.AbstractAction

acceptVisitor, calculateViewOrder, callInitializer, classId, combineKeyStrokes, createUIFacade, dispose, disposeInternal, doAction, doActionInternal, execDispose, execSelectionChanged, getActionId, getAllExtensions, getConfiguredHorizontalAlignment, getConfiguredIconId, getConfiguredInheritAccessibility, getConfiguredKeyStroke, getConfiguredSeparator, getConfiguredToggleAction, getConfiguredTooltipText, getConfiguredViewOrder, getContainer, getExtension, getHorizontalAlignment, getIconId, getKeyStroke, getMnemonic, getOrder, getProperty, getText, getTextWithMnemonic, getTooltipText, getUIFacade, hasProperty, initAction, interceptAction, interceptDispose, interceptInitAction, interceptInitConfig, interceptSelectionChanged, isEnabled, isEnabledGranted, isEnabledInheritAccessibility, isEnabledProcessingAction, isInheritAccessibility, isSelected, isSeparator, isThisAndParentsEnabled, isThisAndParentsVisible, isToggleAction, isVisible, isVisibleGranted, setContainerInternal, setEnabled, setEnabledGranted, setEnabledInheritAccessibility, setEnabledPermission, setEnabledProcessingAction, setHorizontalAlignment, setIconId, setInheritAccessibility, setKeyStroke, setOrder, setProperty, setSelected, setSelectedInternal, setSeparator, setText, setToggleAction, setTooltipText, setView, setVisible, setVisibleGranted, setVisiblePermission

Methods inherited from class org.eclipse.scout.rt.platform.reflect.AbstractPropertyObserver

addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getSpecificPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.scout.rt.client.ui.action.view.IViewButton

getDisplayStyle

Methods inherited from interface org.eclipse.scout.rt.client.ui.action.IAction

acceptVisitor, dispose, doAction, getActionId, getContainer, getHorizontalAlignment, getIconId, getKeyStroke, getMnemonic, getProperty, getText, getTextWithMnemonic, getTooltipText, getUIFacade, hasProperty, initAction, isEnabled, isEnabledGranted, isEnabledInheritAccessibility, isEnabledProcessingAction, isInheritAccessibility, isSelected, isSeparator, isThisAndParentsEnabled, isThisAndParentsVisible, isToggleAction, isVisible, isVisibleGranted, setContainerInternal, setEnabled, setEnabledGranted, setEnabledInheritAccessibility, setEnabledPermission, setEnabledProcessingAction, setHorizontalAlignment, setIconId, setInheritAccessibility, setKeyStroke, setProperty, setSelected, setSeparator, setText, setToggleAction, setTooltipText, setView, setVisible, setVisibleGranted, setVisiblePermission

Methods inherited from interface org.eclipse.scout.rt.platform.reflect.IPropertyObserver

addPropertyChangeListener, addPropertyChangeListener, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from interface org.eclipse.scout.rt.platform.classid.ITypeWithClassId

classId

Methods inherited from interface org.eclipse.scout.rt.platform.IOrdered

getOrder, setOrder

Constructor Detail

AbstractOutlineViewButton

public AbstractOutlineViewButton(IDesktop desktop,
                                 Class<? extends IOutline> outlineType)

call using AbstractDesktop.this or AbstractDesktopExtension#getDelegatingDesktop()

Method Detail

execInitAction

protected void execInitAction()

Description copied from class: AbstractAction

called by AbstractAction.initAction()
this way a menu can for example add/remove custom child menus

Overrides:

execInitAction in class AbstractAction

execAction

protected void execAction()

Activates the associated outline if it is not the desktop's active outline.

Overrides:

execAction in class AbstractAction

getConfiguredEnabled

protected final boolean getConfiguredEnabled()

since execInitAction sets the value of this method to the value of the outline. The getConfigured does not have any affect.

Overrides:

getConfiguredEnabled in class AbstractAction

Returns:

true if the action can be selected and false otherwise

getConfiguredText

protected final String getConfiguredText()

since execInitAction sets the value of this method to the value of the outline. The getConfigured does not have any affect.

Overrides:

getConfiguredText in class AbstractAction

getConfiguredVisible

protected final boolean getConfiguredVisible()

since execInitAction sets the value of this method to the value of the outline. The getConfigured does not have any affect.

Overrides:

getConfiguredVisible in class AbstractAction

Returns:

true if the action is visible and false otherwise

getDesktop

public IDesktop getDesktop()

Specified by:

getDesktop in interface IOutlineViewButton

getOutline

public IOutline getOutline()

Specified by:

getOutline in interface IOutlineViewButton

createLocalExtension

protected IOutlineViewButtonExtension<? extends AbstractOutlineViewButton> createLocalExtension()

Overrides:

createLocalExtension in class AbstractViewButton