ToolbarButton (Maximo API)

java.lang.Object
- psdi.webclient.system.controller.BaseInstance
- - psdi.webclient.system.controller.ControlInstance
  - - psdi.webclient.controls.ToolbarButton

All Implemented Interfaces:

java.lang.Cloneable
```
public class ToolbarButton
extends ControlInstance
```
This control class manages the enabled/disabled state of the toolbar button.
A toolbar button is enabled when one of the following is true:
no tab on which it is enabled is provided in its definition
it is configured to appear on ALL tabs
it is configured to appear on a given tab and the current tab name is the same (including the LIST tab)
it is configured to appear on the MAIN tab and the current tab is not the list tab

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String ACTION_NEXT

static java.lang.String ACTION_PREVIOUS

static java.lang.String ACTION_STRECLOCK
- Fields inherited from class psdi.webclient.system.controller.ControlInstance
  amIinitialize, DATASOURCE, errorChanged, errorLevel, errorsValidated, generatedControl, INPUTMODE, labelOverride, labelParams, LOG_CATEGORY, ONDATACAHNGE, originalControl, PARAM_APP, PARAM_APPTABTYPE, PARAM_DESIGNMODE, PARAM_LIGHTNING, PARAM_MOBILE, PARAM_MODULE, PARAM_PAGE, PARAM_PARENTCOMPONENT, PARAM_PARENTCONTROL, PARAM_PRESENTATION, PARAM_SCREENREADER, PARAM_SKINNAME, PARAM_TAB, PARAM_TABGROUP, PARAM_TABGROUP_MAIN, PARAM_TABLE, PARAM_USERINFO, PARAM_VERTICALLABEL, propertyOriginator, RERENDER_PROPERTY
- Fields inherited from class psdi.webclient.system.controller.BaseInstance
  changedProperties, EXCEPTION_ERROR, EXCEPTION_INFO, EXCEPTION_NONE, EXCEPTION_REQUIREDFIELD, EXCEPTION_SMARTFILL, EXCEPTION_WARNING, EXCEPTION_YESNOCANCEL, FORCE_WARNING_HANDLING, NO_PROMPT_WITH_WARNING, presentationTags, PROMPT_WHEN_WARNING_EXIST, properties, type

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ACTION_NEXT`
`static java.lang.String`	`ACTION_PREVIOUS`
`static java.lang.String`	`ACTION_STRECLOCK`

Constructor Summary

Constructors
Constructor and Description

ToolbarButton()

Constructors
Constructor and Description
`ToolbarButton()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addSep()`
`void`	`dynamicButtonHandling()`
`void`	`eventCheck()` Checks to see if the control has an mxevent and if the user has access to it.
`protected boolean`	`hasSigOptionAccess(java.lang.String sigoption, DataBean dataBean, int row)`
`void`	`initialize()` should be extended to do any setup required by the instance.
`boolean`	`isDisabled()`
`boolean`	`isFirstButton()`
`boolean`	`isVisible()` Return whether or not the instance is visible or not (Whether or not it should be shown) Each control or component will handle visibility in it's own way.
`boolean`	`needsSep()`
`boolean`	`preRender()`
`int`	`render()` Render this control's components
`void`	`setIsFirstButton(boolean aBool)`
`void`	`setVisibility(boolean visible)`

Methods inherited from class psdi.webclient.system.controller.ControlInstance
addChild, addComponent, broadcastEvent, canInsert, canInsert, canRemove, childHasError, childHasErrorFocus, cleanup, clearComponent, clearErrors, clearFlags, copy, createRenderId, determineErrorLevel, errorLevelChanged, findComponentByDescriptorId, findDesignerProperty, findProperty, findUseForLablledByComponent, getAdaptorInstance, getBoundComponent, getComponent, getComponents, getConditonallyChanged, getDataBean, getDataSource, getDescriptorControl, getDesignerProperty, getDesignerSelected, getDesignerSelectedControl, getElement, getErrorLevel, getGeneratedControl, getOriginalControl, getOriginalProperty, getProperties, getProperty, getProperty, getPropertyIgnoreFlags, getPropertyOriginator, getPropertyUncle, getRecordHover, getSkipPreRender, getTableControl, getTakesValueComponent, handleEvent, hasChanged, hasChangedConditionally, hasChildElements, hasMaskedChanged, hasRecordHover, hasVisibleChildren, instantiatedatasrc, isDesignerEditedProperty, isFirstChildVisible, isFocusable, isGenerated, isHiddenByLicense, isIncluded, isLastChild, isMainrecActionMenu, isMasked, isOnTableFilterRow, isOnTableTitleRow, isPersistentProperty, isReInitialize, isSelected, isToBeDisplayedOnCurrentTab, isToBeDisplayedOnTab, launchexternal, licenseCheck, moveChild, needsRender, parentPropertyChanged, parseParamvalues, preRenderChecks, propertyChanged, quickinsert, registerDesignerEditedProperty, reInitialize, removeChild, renderChildren, resetDataSource, resolveParam, resolveParams, setAttributeError, setBoundComponent, setChangedFlag, setChangedFlag, setConditionalProperties, setDesignerSelected, setDisabled, setElement, setErrorFocusOnControl, setFocus, setFocus, setFocusable, setFocusTable, setGenerated, setGeneratedControl, setIncluded, setIncluded, setNeedsRender, setOnTableFilterRow, setOnTableRow, setOnTableTitleRow, setOriginalControl, setPropertyOriginator, setPropertyUncle, setReInitialize, setReRenderFlags, setSelected, setSkipPreRender, setTableControl, sigOptionCheck, sigOptionCheckForLookups, stopRender, walkForId, walkForId

Methods inherited from class psdi.webclient.system.controller.BaseInstance
addChild, addChild, addRefreshListener, canSetProperty, clearChildren, clearPropChangeList, clearProperties, clone, clone, getBoolean, getChangedProperties, getChildCount, getChildIndex, getChildren, getConsiderInDesigner, getDescriptor, getId, getIdExtension, getInt, getLocalizedType, getPage, getParent, getParentInstance, getPropertyNames, getRefreshListeners, getRenderId, getRowNum, getSafeId, getString, getType, getWebClientSession, handleEvent, hasAnyPropertyChanged, hasLocalProperty, hasPropertyChanged, initProperty, isDynamicContainer, isOnTable, isOnTableRow, maintainControlId, removeProperty, setConsiderInDesigner, setDescriptor, setDynamicContainer, setOnTable, setParent, setProperty, setProperty, setRenderId, setType, setWebClientSession, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - ACTION_PREVIOUS
```
public static final java.lang.String ACTION_PREVIOUS
```
    See Also:
    
    Constant Field Values
  - ACTION_NEXT
```
public static final java.lang.String ACTION_NEXT
```
    See Also:
    
    Constant Field Values
  - ACTION_STRECLOCK
```
public static final java.lang.String ACTION_STRECLOCK
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ToolbarButton
```
public ToolbarButton()
```
- Method Detail
  - initialize
```
public void initialize()
```
    Description copied from class: BaseInstance
    
    should be extended to do any setup required by the instance. for example, the DatasrcInstance will call initialize to create data sources found in the bind list.
    
    Overrides:
    
    initialize in class ControlInstance
  - isDisabled
```
public boolean isDisabled()
```
    Overrides:
    
    isDisabled in class ControlInstance
  - needsSep
```
public boolean needsSep()
```
  - addSep
```
public void addSep()
```
  - preRender
```
public boolean preRender()
```
    Overrides:
    
    preRender in class ControlInstance
  - dynamicButtonHandling
```
public void dynamicButtonHandling()
```
  - isVisible
```
public boolean isVisible()
```
    Description copied from class: BaseInstance
    
    Return whether or not the instance is visible or not (Whether or not it should be shown) Each control or component will handle visibility in it's own way.
    
    Overrides:
    
    isVisible in class ControlInstance
    
    Returns:
    
    true - visible, false - not visible
  - hasSigOptionAccess
```
protected boolean hasSigOptionAccess(java.lang.String sigoption,
                                     DataBean dataBean,
                                     int row)
```
    Overrides:
    
    hasSigOptionAccess in class ControlInstance
  - eventCheck
```
public void eventCheck()
```
    Description copied from class: ControlInstance
    
    Checks to see if the control has an mxevent and if the user has access to it. If not, the control is disabled. Otherwise the control is enabled.
    
    Overrides:
    
    eventCheck in class ControlInstance
  - render
```
public int render()
           throws java.lang.NoSuchMethodException,
                  java.lang.IllegalAccessException,
                  java.lang.reflect.InvocationTargetException
```
    Description copied from class: ControlInstance
    
    Render this control's components
    
    Overrides:
    
    render in class ControlInstance
    
    Throws:
    
    java.lang.NoSuchMethodException
    
    java.lang.IllegalAccessException
    
    java.lang.reflect.InvocationTargetException
  - setVisibility
```
public void setVisibility(boolean visible)
```
    Overrides:
    
    setVisibility in class ControlInstance
  - isFirstButton
```
public boolean isFirstButton()
```
  - setIsFirstButton
```
public void setIsFirstButton(boolean aBool)
```

Fields inherited from class psdi.webclient.system.controller.ControlInstance

Fields inherited from class psdi.webclient.system.controller.BaseInstance

Methods inherited from class psdi.webclient.system.controller.ControlInstance

Methods inherited from class psdi.webclient.system.controller.BaseInstance

Methods inherited from class java.lang.Object

ACTION_PREVIOUS

ACTION_NEXT

ACTION_STRECLOCK

ToolbarButton

initialize

isDisabled

needsSep

addSep

preRender

dynamicButtonHandling

isVisible

hasSigOptionAccess

eventCheck

render

setVisibility

isFirstButton

setIsFirstButton