Component (plum-view 0.1.26 API)

java.lang.Object
- net.abstractfactory.common.TreeNode
- - net.abstractfactory.plum.view.component.Component

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

Button, CheckBox, DateTimePicker, DropdownList, FileView, Grid, HorizontalBox, ImageView, Label, ListBox, ListItemView, MenuItem, PackingCase, Panel, PasswordBox, RadioField, Screen, SpinBox, TextArea, TextBox, VerticalBox, Window
```
public abstract class Component
extends TreeNode
```
Any component is a container by default. But it should not always be a container.

Author:

HZ00260

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected Color`	`backgroundColor`
`protected String`	`caption`
`protected Color`	`color`
`protected boolean`	`disabled`
`static String`	`EVENT_BEFORE_REFRESH_VIEW` refresh only sync abstract view to (remote) native view.
`static String`	`EVENT_BEFORE_UPDATE_VIEW` usually view should load data from model.
`static String`	`EVENT_STATE_CHANGE` any part of the view changes that the Controller may interested.
`static String`	`EVENT_VALUE_CHANGE` usually used to update model.
`protected Font`	`font`
`protected String`	`id` it is unique
`protected String`	`name`
`protected boolean`	`readOnly`
`protected boolean`	`visible`

Constructor Summary

Constructors
Constructor and Description

Component()

Constructors
Constructor and Description
`Component()`

Method Summary

Methods
Modifier and Type	Method and Description
`abstract Object`	`accept(Visitor visitor)`
`void`	`addChild(Component comp)`
`void`	`addChild(Component uic, boolean autoremovePackingCase)`
`void`	`addChildren(Component[] uics)`
`void`	`addEventListener(String event, EventListener listener)`
`void`	`clearEventListener()`
`boolean`	`containsListener(String event)`
`void`	`destroy()` free resource, such as file, thread, etc.
`boolean`	`existsEventListener(String event, EventListener listener)`
`Window`	`findWindow()` find the belonging window
`void`	`forceUpdateView()` trigger STATE_CHANGE event.
`Color`	`getBackgroundColor()`
`String`	`getCaption()`
`Component`	`getChildComponentById(String id)`
`Component`	`getChildComponentByName(String name)`
`List<Component>`	`getChildrenComponents()`
`Color`	`getColor()`
`protected Component`	`getComponentByClass(Class clazz)` original idea is to make a "getWindow()", but, I don't want to let this class depend on the Window class.
`Object`	`getExtraAttribute(String name)`
`Map<String,Object>`	`getExtraAttributes()`
`Font`	`getFont()`
`Font`	`getFont(boolean createIfNull)`
`String`	`getId()`
`Object`	`getModel()`
`String`	`getName()`
`Window`	`getWindow()`
`void`	`hide()`
`boolean`	`isDisabled()`
`boolean`	`isReadOnly()`
`boolean`	`isVisible()`
`boolean`	`isWindow()`
`void`	`notifyEventListeners(String event)`
`void`	`notifyEventListeners(String event, Object... parameters)`
`void`	`removeChild(Component uic)`
`void`	`removeEventListener(String event, EventListener listener)`
`void`	`removeExtraAttribute(String name)`
`void`	`setBackgroundColor(Color backgroundColor)`
`void`	`setCaption(String caption)`
`void`	`setColor(Color color)`
`void`	`setDisabled(boolean disabled)`
`void`	`setExtraAttribute(String name, Object value)`
`void`	`setFont(Font font)`
`void`	`setId(String id)`
`void`	`setModel(Object model)`
`void`	`setModel(Object model, boolean updateView)`
`void`	`setName(String name)`
`void`	`setReadOnly(boolean readOnly)`
`void`	`setVisible(boolean visible)`
`void`	`show()`
`String`	`toString()`
`protected Component`	`tranverse(net.abstractfactory.plum.view.component.Component.Find find, int depth)`
`void`	`updateModel()` sync values from view to model
`void`	`updateView()` sync values from model to view.

Methods inherited from class net.abstractfactory.common.TreeNode
addChild, addChild, addChildren, checkConsistency, copy, detach, getChildren, getDepth, getParent, getRoot, isLeaf, isRoot, remove, removeAllChildren, removeChild, replace, replaceSingleNode, setChildren, setParent

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

Field Detail
- EVENT_BEFORE_REFRESH_VIEW
```
public static final String EVENT_BEFORE_REFRESH_VIEW
```
  refresh only sync abstract view to (remote) native view.
  
  See Also:
  Constant Field Values
- EVENT_BEFORE_UPDATE_VIEW
```
public static final String EVENT_BEFORE_UPDATE_VIEW
```
  usually view should load data from model.
  
  See Also:
  Constant Field Values
- EVENT_STATE_CHANGE
```
public static final String EVENT_STATE_CHANGE
```
  any part of the view changes that the Controller may interested.
  
  See Also:
  Constant Field Values
- EVENT_VALUE_CHANGE
```
public static final String EVENT_VALUE_CHANGE
```
  usually used to update model.
  
  See Also:
  Constant Field Values
- id
```
protected String id
```
  it is unique
- name
```
protected String name
```
- caption
```
protected String caption
```
- font
```
protected Font font
```
- color
```
protected Color color
```
- backgroundColor
```
protected Color backgroundColor
```
- disabled
```
protected boolean disabled
```
- readOnly
```
protected boolean readOnly
```
- visible
```
protected boolean visible
```

Constructor Detail
- Component
```
public Component()
```

Method Detail

getName
```
public String getName()
```

setName
```
public void setName(String name)
```

getCaption
```
public String getCaption()
```

setCaption

public void setCaption(String caption)

isDisabled
```
public boolean isDisabled()
```

setDisabled

public void setDisabled(boolean disabled)

isReadOnly
```
public boolean isReadOnly()
```

setReadOnly

public void setReadOnly(boolean readOnly)

isVisible
```
public boolean isVisible()
```

setVisible

public void setVisible(boolean visible)

show
```
public void show()
```

hide
```
public void hide()
```

getId
```
public String getId()
```

setId
```
public void setId(String id)
```

getFont
```
public Font getFont()
```

getFont

public Font getFont(boolean createIfNull)

setFont
```
public void setFont(Font font)
```

getColor
```
public Color getColor()
```

setColor
```
public void setColor(Color color)
```

getBackgroundColor
```
public Color getBackgroundColor()
```

setBackgroundColor

public void setBackgroundColor(Color backgroundColor)

getExtraAttributes

public Map<String,Object> getExtraAttributes()

getExtraAttribute

public Object getExtraAttribute(String name)

setExtraAttribute

public void setExtraAttribute(String name,
                     Object value)

removeExtraAttribute

public void removeExtraAttribute(String name)

toString
```
public String toString()
```
Overrides:

toString in class Object

addChild
```
public void addChild(Component comp)
```

addChild

public void addChild(Component uic,
            boolean autoremovePackingCase)

addChildren

public void addChildren(Component[] uics)

removeChild

public void removeChild(Component uic)

getChildComponentByName

public Component getChildComponentByName(String name)

getChildrenComponents

public List<Component> getChildrenComponents()

getChildComponentById

public Component getChildComponentById(String id)

tranverse

protected Component tranverse(net.abstractfactory.plum.view.component.Component.Find find,
                  int depth)

findWindow
```
public Window findWindow()
```
find the belonging window

Returns:

isWindow
```
public boolean isWindow()
```

getComponentByClass
```
protected Component getComponentByClass(Class clazz)
```
original idea is to make a "getWindow()", but, I don't want to let this class depend on the Window class.

Parameters:
clazz -

Returns:

getWindow
```
public Window getWindow()
```

getModel
```
public Object getModel()
```

setModel
```
public void setModel(Object model)
```

setModel

public void setModel(Object model,
            boolean updateView)

updateModel
```
public void updateModel()
```
sync values from view to model

updateView
```
public void updateView()
```
sync values from model to view.

accept

public abstract Object accept(Visitor visitor)

addEventListener

public void addEventListener(String event,
                    EventListener listener)

removeEventListener

public void removeEventListener(String event,
                       EventListener listener)

existsEventListener

public boolean existsEventListener(String event,
                          EventListener listener)

clearEventListener
```
public void clearEventListener()
```

containsListener

public boolean containsListener(String event)

notifyEventListeners

public void notifyEventListeners(String event)

notifyEventListeners

public void notifyEventListeners(String event,
                        Object... parameters)

forceUpdateView
```
public void forceUpdateView()
```
trigger STATE_CHANGE event.

destroy
```
public void destroy()
```
free resource, such as file, thread, etc.

Class Component

Field Summary

Constructor Summary

Method Summary

Methods inherited from class net.abstractfactory.common.TreeNode

Methods inherited from class java.lang.Object

Field Detail

EVENT_BEFORE_REFRESH_VIEW

EVENT_BEFORE_UPDATE_VIEW

EVENT_STATE_CHANGE

EVENT_VALUE_CHANGE

id

name

caption

font

color

backgroundColor

disabled

readOnly

visible

Constructor Detail

Component

Method Detail

getName

setName

getCaption

setCaption

isDisabled

setDisabled

isReadOnly

setReadOnly

isVisible

setVisible

show

hide

getId

setId

getFont

getFont

setFont

getColor

setColor

getBackgroundColor

setBackgroundColor

getExtraAttributes

getExtraAttribute

setExtraAttribute

removeExtraAttribute

toString

addChild

addChild

addChildren

removeChild

getChildComponentByName

getChildrenComponents

getChildComponentById

tranverse

findWindow

isWindow

getComponentByClass

getWindow

getModel

setModel

setModel

updateModel

updateView

accept

addEventListener

removeEventListener

existsEventListener

clearEventListener

containsListener

notifyEventListeners

notifyEventListeners

forceUpdateView

destroy